home dictionary doc

RegRequestInfo

Name RegRequestInfo
Usage CourseRegistrationService
calculateCreditLoadForRegRequest createRegRequest updateRegRequest validateRegRequest verifyRegRequest createRegRequestFromExisting getRegRequest getRegRequestsByIds getRegRequestsForStudentByTerm getRegRequestsForCourseRegistration getRegRequestsForCourseOffering getRegRequestsForCourseOfferingByStudent
Type Complex

Description

The request made to the service from the application to register for
course(s). The attributes of this entity include requester (which will be the
student in most cases), request id and term. Each of the reg group the
students want to register would be a registration request item in the Request
object. For every transactional operation from the application, a new
Registration request is created.

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  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
typeKey Type Key String The type of the overall registration request. Required Read only One Yes  
stateKey State Key String Represents the state of the overall registration request. Required   One Yes  
requestorId Requestor Id String Returns the id of the person who requested the course registration. Most
of the times it would be a student but it could also be an admin or
faculty making a request on behalf of the student		     One No  
termId Term Id String Returns the key of the {@link Term} of the registration request     One No  
regRequestItems Reg Request Items RegRequestItemInfoList Returns a list of {@link RegRequestItem} that the RegRequest is composed
of.		     Many 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