LprRosterEntryInfo

Name LprRosterEntryInfo
Usage LprRosterService
getLprRosterEntry getLprRosterEntriesByIds getLprRosterEntriesByLprRoster getLprRosterEntriesByLpr getLprRosterEntriesByLprRosterAndLpr searchForLprRosterEntries createLprRosterEntry updateLprRosterEntry
Type Complex

Description

Copyright 2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the
"License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at

http://www.osedu.org/licenses/ECL-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.

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  
lprRosterId LprRoster Id String The LPR Roster Id to which this LPR roster entry belongs. Required Read only One No  
lprId Lpr Id String The LPR Id of this entry. Required Read only One No  
position Position Integer The position of this entry within an ordered LPR Roster.

If not supplied when the entry is created the service should
set it to the next sequential number available if needed for an
ordered roster.

The service does not have to guarantee uniqueness of this field
within a roster.

This field cannot be relied upon to determine exactly how many
people are ahead of a person in the roster because the sequence
may contain gaps (because of deletes) or duplicates. Moreover
a particular roster may order entries using different
algorithms, for example it may be FIFO or LIFO or it may take
other factors into account, such as the state, to determine
which entry process next.		     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