EnrollmentRecord

public class EnrollmentRecord

EnrollmentRecordrepresents enrollment which will be returned when schedule tracking service is queried for enrollments. It holds the details of an enrollment.

See also: org.motechproject.scheduletracking.service.ScheduleTrackingService

Constructors

EnrollmentRecord

public EnrollmentRecord()

Methods

getCurrentMilestoneName

public String getCurrentMilestoneName()

Returns the current milestone name of an enrollment.

Returns:the current milestone name

getEnrollmentDateTime

public DateTime getEnrollmentDateTime()

Returns the date and time of an enrollment.

Returns:the enrollment date and time

getExternalId

public String getExternalId()

Returns the client external id.

Returns:the client external id

getMetadata

public Map<String, String> getMetadata()

Returns the metadata associated with the enrollment.

Returns:the metadata

getPreferredAlertTime

public Time getPreferredAlertTime()

Returns the preferred alert time of an enrollment.

Returns:the preferred alert time

getReferenceDateTime

public DateTime getReferenceDateTime()

Returns the reference date and time of an enrollment.

Returns:the reference date and time

getScheduleName

public String getScheduleName()

Returns the schedule name of an enrollment.

Returns:the schedule name

getStartOfDueWindow

public DateTime getStartOfDueWindow()

Returns the due window start date and time of current milestone of an enrollment.

Returns:the due window start date and time

getStartOfEarliestWindow

public DateTime getStartOfEarliestWindow()

Returns the earliest window start date and time of current milestone of an enrollment.

Returns:the earliest window start date and time

getStartOfLateWindow

public DateTime getStartOfLateWindow()

Returns the late window start date and time of current milestone of an enrollment.

Returns:the late window start date and time

getStartOfMaxWindow

public DateTime getStartOfMaxWindow()

Returns the max window start date and time of current milestone of an enrollment.

Returns:the max window start date and time

getStatus

public String getStatus()

Returns the status of the enrollment.

Returns:the enrollment status

setCurrentMilestoneName

public EnrollmentRecord setCurrentMilestoneName(String currentMilestoneName)

setDueStart

public EnrollmentRecord setDueStart(DateTime dueStart)

setEarliestStart

public EnrollmentRecord setEarliestStart(DateTime earliestStart)

setEnrollmentDateTime

public EnrollmentRecord setEnrollmentDateTime(DateTime enrollmentDateTime)

setExternalId

public EnrollmentRecord setExternalId(String externalId)

setLateStart

public EnrollmentRecord setLateStart(DateTime lateStart)

setMaxStart

public EnrollmentRecord setMaxStart(DateTime maxStart)

setMetadata

public EnrollmentRecord setMetadata(Map<String, String> metadata)

setPreferredAlertTime

public EnrollmentRecord setPreferredAlertTime(Time preferredAlertTime)

setReferenceDateTime

public EnrollmentRecord setReferenceDateTime(DateTime referenceDateTime)

setScheduleName

public EnrollmentRecord setScheduleName(String scheduleName)

setStatus

public EnrollmentRecord setStatus(String status)