home

CourseWaitlistOption

Name CourseWaitlistOption
Usage CourseRegistrationService
CourseWaitlistInfo
Type Complex

Description

The CourseWaitlistOption represents a single waitlist for a reg group in a
course. It contains the reg group id for which this particular option is for
and the clearing strategy, i.e., the method how this waitlist will be
cleared. If the course has just one waitlist clearing methods for all
reg-groups, then the number of CourseWailtlistOptions will be as many as the
reg groups in the course. If a course has just one reg group, only one of
this entity has to be created.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute? Implementation Notes
regGroupId Reg Group Id String The reg group for the waitlist option, a waitlist can be created for a
particular reg group the students try to enroll in.		 One No  
clearingStrategy Clearing Strategy String Return one of the course waitlist clearing strategies - automatic,
semi-automatic or manual for this particular reg-group.		 One No  
checkInRequired Check In Required Boolean Returns if check-in by a student on the list is required by this
waitlist.		 One No  
checkInFrequency Check In Frequency TimeAmount Returns the check in frequency for the Waitlist. A Waitlist might have a
check in frequency requirement for all the students in the Waitlist.		 One No  
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and can therefore be a large hex value for example
  • An id value might be 23b9ca9bd203df902
  • An Id is never intended to be used directly by an end user.
  • Ids are assumed to be of different values in different KS implementations
  • Id values are generated by the service implementations
  • Id values are never expected to be used in Configuration or Application code
 One No  
name Name String A display name for this entity. One No  
descr Description RichText A description of the entity. One No  
attributes Dynamic Attributes AttributeList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		 Many No  
meta Create/Update meta info Meta Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 One No  
typeKey Type Key String Unique identifier for the type of this object. One No  
stateKey State Key String Unique identifier for the state of this object. One No