home

CourseWaitlistInfo

Name CourseWaitlistInfo
Usage CourseRegistrationService
searchForCourseWaitlists searchForCourseWaitlistEntries searchForCourseWaitlistEntryIds
Type Complex

Description

Represents a list of students who wish to register to the reg group but
cannot because of seat unavailability. A waitlist is a Queue at the class I
level. As more seats become available the students in the waitlist are moved
to the course. The waitlist entries are LPRs which are in a state denoting
that the student is in a waitlist. There are three waitlist-clearing
strategies - automatic, semi-automatic and manual which are part of the
CourseWaitlistOption. A single waitlist is created for a particular course
offering. The waitlist may vary by each reg group in the course offering;
this is captured by the CourseWaitlistOption.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute? Implementation Notes
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 Yes  
typeKey Type Key String Unique identifier for the type of this object. One Yes  
stateKey State Key String Unique identifier for the state of this object. One Yes  
courseOfferingId Offering Id The Id of the related offering. Note: don't yet know String what kind of offering this is, but it does map to a LUI Id. One No  
courseWailtistEntryIds Course Wailtist Entry Ids StringList Gets all the course waitlist entries in the wailtist. Many No  
meta Create/Update meta info MetaInfo 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  
attributes Dynamic Attributes AttributeInfoList 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