org.kuali.student.enrollment.coursewaitlist.infc

Interface CourseWaitList

All Superinterfaces:

HasAttributes, HasAttributesAndMeta, HasEffectiveDates, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdNamelessEntity, TypeStateEntity

All Known Implementing Classes:

CourseWaitListInfo

public interface CourseWaitList
extends IdNamelessEntity, HasEffectiveDates

Represents a course wait list that is attached to a set of FOs and related AOs. A set of CourseWaitListEntries may be attached to this CourseWaitList. These entries represent the students that are on the course wait list.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getActivityOfferingIds() The activity offering Ids associated with this CourseWaitList.
Boolean	getAllowHoldUntilEntries() Indicates if hold until entries are allowed on this CourseWaitList.
Boolean	getAutomaticallyProcessed() Indicates if the CourseWaitListEntries associated with this CourseWaitList are automatically processed.
TimeAmount	getCheckInFrequency() The amount of time that a student is required to check-in before they will be removed from this CourseWaitList.
Boolean	getCheckInRequired() Indicates if a student is required to check in at some interval to remain on this course wait list.
Boolean	getConfirmationRequired() Indicates if the CourseWaitListEntries associated with this CourseWaitList must acknowledge/confirm that they want to be added to the relevant course when they are processed.
List<String>	getFormatOfferingIds() The format offering Ids associated with this CourseWaitList.
Integer	getMaxSize() The maximum size of this CourseWaitList.
Boolean	getRegisterInFirstAvailableActivityOffering() Indicates if the entries in this wait list may be added using any activity offering associated with this wait list.
String	getStateKey() A unique identifier for the state of this object.

Methods inherited from interface org.kuali.student.r2.common.infc.HasId

getId

Methods inherited from interface org.kuali.student.r2.common.infc.HasType

getType, getTypeKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasState

getState

Methods inherited from interface org.kuali.student.r2.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.r2.common.infc.HasMeta

getMeta

Methods inherited from interface org.kuali.student.r2.common.infc.HasEffectiveDates

getEffectiveDate, getExpirationDate

Method Detail

getStateKey

String getStateKey()

A unique identifier for the state of this object. This value should not be changed directly. Instead, it should be set using the appropriate change state method in service.

Specified by:

getStateKey in interface HasState

getFormatOfferingIds

List<String> getFormatOfferingIds()

The format offering Ids associated with this CourseWaitList.

getActivityOfferingIds

List<String> getActivityOfferingIds()

The activity offering Ids associated with this CourseWaitList.

getMaxSize

Integer getMaxSize()

The maximum size of this CourseWaitList. This value will always be positive. Zero represents an unlimited size.

getRegisterInFirstAvailableActivityOffering

Boolean getRegisterInFirstAvailableActivityOffering()

Indicates if the entries in this wait list may be added using any activity offering associated with this wait list. If set to false only the registration group associated with the entry should be used.

getAutomaticallyProcessed

Boolean getAutomaticallyProcessed()

Indicates if the CourseWaitListEntries associated with this CourseWaitList are automatically processed.

getConfirmationRequired

Boolean getConfirmationRequired()

Indicates if the CourseWaitListEntries associated with this CourseWaitList must acknowledge/confirm that they want to be added to the relevant course when they are processed.

getCheckInRequired

Boolean getCheckInRequired()

Indicates if a student is required to check in at some interval to remain on this course wait list.

getCheckInFrequency

TimeAmount getCheckInFrequency()

The amount of time that a student is required to check-in before they will be removed from this CourseWaitList.

getAllowHoldUntilEntries

Boolean getAllowHoldUntilEntries()

Indicates if hold until entries are allowed on this CourseWaitList. An entry is considered a hold until entry if it is in a specific state.