LprTransactionItemInfo

Name LprTransactionItemInfo
Usage LprService
getLprTransactionItemsByPersonAndLui getLprTransactionItemsByResultingLpr getLprTransactionItemsByLui
LprTransactionInfo
Type Complex

Description

A transaction item represents a request for creating a new relation of a
person (student) to a LUI. The transaction item also handle removing,
updating, swapping out an old LUI for a new LUI for a person.

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  
personId Person Id String The person id for whom this request is to generate or update the lpr Required   One No  
transactionId Transaction Id String The identifier of the transaction that contains this transaction item. Required Read only One No  
newLuiId New LUI Id String The LUI id for a new relation request.     One No  
existingLuiId Existing Lui Id String The existing LUI id for an existing relation remove or change requests.     One No  
resultValuesGroupKeys Result Values Group Keys StringList The keys of the result values groups to be applied to the LPR
once created.

For example, setting the grading option to pass/fail or the credits to 3
for a course.
    Many No  
requestOptions Request Options LprTransactionItemRequestOptionInfoList Specify the various request (or registration ) options for creating this
relationship.
    Many No  
lprTransactionItemResult LPR Transaction Item Result LprTransactionItemResultInfo Returns the result for this transaction item once it has been processed.     One No  
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 transaction item.

The types of LPR transaction item are things like ADD, UPDATE, DROP,
and SWAP
Required Read only One Yes  
stateKey State Key String The state of this transaction item

The states of the LPR transaction item are things like DRAFT, SUBMITTED,
and FAILED. etc
Required   One Yes  
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