RegistrationRequestInfo

Name RegistrationRequestInfo
Usage CourseRegistrationService
getRegistrationRequest getRegistrationRequestsByIds getRegistrationRequestsByRequestor getUnsubmittedRegistrationRequestsByRequestorAndTerm searchForRegistrationRequests validateRegistrationRequest createRegistrationRequest createRegistrationRequestFromExisting updateRegistrationRequest
Type Complex

Description

All changes to a student registration is performed by submitting a
RegistrationRequest. This request represents an overall transaction
among a set of RegistrationRequestItems (register, add, drop,
update, etc.)

For every transactional operation from the application, a new
Request is created.

RegistrationRequests are created and persisted separate from the
submission and processing. Updating a RegistrationRequest prior to
submission can create the concept of a "cart." Once the
RegistrationRequest is submitted for porcessing it cannot be
updated.

The RegistrationRequest State represents the state of this request
e.g. NEW, DRAFT, SUBMITTED, FAILED.

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 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  
requestorId Requestor Id String The person who is making this request. For a student
self-registering, the requestor is the Id of the student. In
the case of an adminsitrator registering or updating a
registration on behalf of a student, the requestor is the
administrator.

In either case, the student Id is included in each
RegistrationRequestItem.		 Required Read only on update One No LprTransaction.requestingPersonId
termId Term Id String The Term in which this registration takes place. Required Read only on update One No LprTransaction.atpId
registrationRequestItems Registration Request Items RegistrationRequestItemInfoList A list of specific registration request items.     Many No LprTransaction.LprTransactionItems
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