LprRosterInfo

Name LprRosterInfo
Usage LprRosterService
getLprRoster getLprRostersByIds getLprRostersByLui getLprRostersByTypeAndLui searchForLprRosters validateLprRoster createLprRoster updateLprRoster validateLprRosterEntry
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  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
associatedLuiIds Associated Lui Ids StringList This method gets the Ids of the associated LUIs for the LPR
Roster. A roster may be serve one or more Luis.		     Many No  
maximumCapacity Maximum Capacity Integer The maximum capacity of the roster. This number contraints the
maximum number of roster entries in this roster. If null, there
is no roster size constraint. Size constraints are used with
rosters that implement waitlists.		     One No  
checkInRequired CheckIn Required Boolean Is check in required to maintain an active status in this
roster. This is an optional flag for use with rosters that
implement waitlist checkins.		 Required   One No  
checkInFrequency CheckIn Frequency TimeAmountInfo The frequency in terms of time period that an entry has to
check in to maintain active status in this roster. This is only
populated if check in is required for the roster.

This is an optional value for use with rosters that implement
waitlist checkins.		     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