CourseWaitlistEntryInfo

Name CourseWaitlistEntryInfo
Usage CourseWaitlistService
getCourseWaitlistEntry updateCourseWaitlistEntry validateCourseWaitlistEntry getCourseWaitlistEntriesForCourseOffering getCourseWaitlistEntriesForRegGroup getCourseWaitlistEntriesForStudentInCourseOffering getCourseWaitlistEntryForStudentInRegGroup getCourseWaitlistEntriesForStudentByTerm searchForCourseWaitlistEntries
Type Complex

Description

Represents a single student in the course waitlist. Contains information such
as student id, the waitlist option (reg group id and clearing strategy) and
the student's position in the waitlist. As more seats become available the
students in the waitlist are moved to the course.


Implementation Notes:
It is represented by an LPR at Class I level, when a student actually
registers for the course the LPR is a RegGroupRegistration

Structure Definition

ShortName Name Type Description Required? Read only? 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

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
effectiveDate Effective Date Date Date/time this object became effective. Must be less than or
equal to the expirationDate specified.		     One No  
expirationDate Expiration Date Date Date/time this relationship is no longer effective. Must be
greater than or equal to the effectiveDate specified.		     One No  
studentId Student Id String Returns the student id in waitlist entry waitlisted.   Read only on updates One No  
registrationGroupId Registration Group Id String Returns the reg group id for this waitlist entry. A waitlist entry should
always be on tied to a single reg group.		     One No  
position Position Integer Returns the position of this entry in the waitlist for a particular
waitlist option.

This is not directly updatable on the data object, use service operations
to change the student's position in the list		   Read only One No  
lastCheckedIn Last Checked In Date Returns true if the student has checked in to the waitlist. Used to track
if the student is still interested in being in the wailist.		     One No  
courseOfferingId Course Offering Id String Course offering id that contains the   Read only on updates One No  
meta Meta 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.		 Required on updates Read only 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