Enrollment¶
-
public class
Enrollment
¶ Represents details about the client enrollment.
Methods¶
copyFrom¶
-
public Enrollment
copyFrom
(Enrollment enrollment)¶ Creates copy of the given enrollment.
Parameters: - enrollment – the enrollment to copy
Returns: this instance with copied properties
fulfillCurrentMilestone¶
getCurrentMilestoneStartDate¶
getCurrentWindowAsOf¶
-
public WindowName
getCurrentWindowAsOf
(DateTime asOf)¶ Returns the name of the window in the current milestone where the given date and time must be in the window time range.
Parameters: - asOf – the date and time which is the time range of the window
Returns: the window name
getEndOfWindowForCurrentMilestone¶
-
public DateTime
getEndOfWindowForCurrentMilestone
(WindowName windowName)¶ Returns the end date and time of the window with the given name in the current milestone.
Parameters: - windowName – the window name
Returns: the end date and time of the window
getFulfillments¶
-
public List<MilestoneFulfillment>
getFulfillments
()¶
getLastFulfilledDate¶
getStartOfWindowForCurrentMilestone¶
-
public DateTime
getStartOfWindowForCurrentMilestone
(WindowName windowName)¶ Returns the start date and time of the window with the given name in the current milestone.
Parameters: - windowName – the window name
Returns: the start date and time of the window
getStatus¶
-
public EnrollmentStatus
getStatus
()¶
isActive¶
-
public boolean
isActive
()¶ Checks whether the enrollment is active.
Returns: true if the enrollment is active, otherwise false
isCompleted¶
-
public boolean
isCompleted
()¶ Checks whether the enrollment is completed.
Returns: true if the enrollment is completed, otherwise false
setFulfillments¶
-
public void
setFulfillments
(List<MilestoneFulfillment> fulfillments)¶
setSchedule¶
setStatus¶
-
public void
setStatus
(EnrollmentStatus status)¶