org.kuali.student.enrollment.roster.infc
Interface LprRoster

All Superinterfaces:

Entity, HasAttributes, HasAttributesAndMeta, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdEntity, TypeStateEntity

All Known Implementing Classes:

LprRosterInfo

public interface LprRoster
extends IdEntity

LprRoster is a collection or group of LPR Roster entries which can be used to model any collection of LPRs at the class I level, e.g. a garde sheet or a waitlist for a course. The LPR roster entries in an LPR Roster will always belong to of a particular course or to a section(s) within the course. The associated LUIs are a way to show this relation.

Author:

Kuali Student Team (sambit)

Method Summary

List<String>	getAssociatedLuiIds() This method gets the Ids of the associated LUIs for the LPR Roster.
TimeAmountInfo	getCheckInFrequency() The frequency in terms of time period that an entry has to check in to maintain active status in this roster.
Boolean	getCheckInRequired() Is check in required to maintain an active status in this roster.
Integer	getMaximumCapacity() The maximum capacity of the roster.

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

getId

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

getDescr, getName

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, getStateKey

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

getAttributes

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

getMeta

Method Detail

getAssociatedLuiIds

List<String> getAssociatedLuiIds()

This method gets the Ids of the associated LUIs for the LPR Roster. A roster may be serve one or more Luis.

getMaximumCapacity

Integer getMaximumCapacity()

The maximum capacity of the roster. This number contraints the maximum number of roster entries in this roster. If null, there is no roster size constraint. Size constraints are used with rosters that implement waitlists.

getCheckInRequired

Boolean getCheckInRequired()

Is check in required to maintain an active status in this roster. This is an optional flag for use with rosters that implement waitlist checkins.

getCheckInFrequency

TimeAmountInfo getCheckInFrequency()

The frequency in terms of time period that an entry has to check in to maintain active status in this roster. This is only populated if check in is required for the roster. This is an optional value for use with rosters that implement waitlist checkins.