Package dev.getelements.elements.sdk.dao

Interface ScheduleProgressDao

All Known Implementing Classes:

MongoScheduleProgressDao

public interface ScheduleProgressDao

Manages Progress instances for the

Method Summary

Modifier and Type	Method	Description
List<Progress>	assignProgressesForMissionsIn(String scheduleNameOrId, String profileId, Collection<ScheduleEvent> events)	Creates Progress instances for Missions in the supplied list.
Pagination<Progress>	getProgresses(String profileId, String scheduleNameOrId, int offset, int count)	Gets all Progress instances with the supplied profile, schedule, and offet, count
List<Progress>	unassignProgressesForMissionsNotIn(String scheduleNameOrId, String profileId, Collection<ScheduleEvent> events)	Deletes Progress instances for Missions not in the supplied list.

Method Details

getProgresses

Pagination<Progress> getProgresses(String profileId,
 String scheduleNameOrId,
 int offset,
 int count)

Gets all Progress instances with the supplied profile, schedule, and offet, count

Parameters:

profileId - Profile identifier

scheduleNameOrId - the Schedule name or ID

offset - offset

count - count

Returns:

the list of Progress

assignProgressesForMissionsIn

List<Progress> assignProgressesForMissionsIn(String scheduleNameOrId,
 String profileId,
 Collection<ScheduleEvent> events)

Creates Progress instances for Missions in the supplied list. If the missions are already assigned, then no changes will be made. If a Progress with the mission is already assigned, then this will ensure that the Mission is now linked to the Schedule if not already assigned.

Parameters:

scheduleNameOrId - the Schedule name or ID

profileId - Profile identifier

events -

Returns:

the list of Progress

unassignProgressesForMissionsNotIn

List<Progress> unassignProgressesForMissionsNotIn(String scheduleNameOrId,
 String profileId,
 Collection<ScheduleEvent> events)

Deletes Progress instances for Missions not in the supplied list. If no other Schedule links the Mission, then this will permamently remove the Progress instances.

Parameters:

scheduleNameOrId - the Schedule name or ID

profileId - Profile identifier

events - the events to schedule

Returns:

the list of Progress