StateInfo

Name StateInfo
Usage AcademicCalendarService StateService
getAcademicCalendarState getAcademicCalendarStates getHolidayCalendarState getHolidayCalendarStates getTermState getTermStates getKeyDateState getKeyDateStates getAcalEventState getAcalEventStates getHolidayState getHolidayStates getState getStatesByKeys getStatesByLifecycle searchForStates validateState createState updateState
Type Complex

Description

Describes the state of an object

States are used in Kuali Student to decribe where the entity is
within a lifecycle.

For example: A new course may be created in a "draft" state, then
move to a "submitted" state for review until it is finally
"approved".

Most of validation of the the fields on the entity should be based
on state in combination with the entity's type.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
key Key String Unique key to this object. Unlike an Id this key can be
explicitly set by the application and is intended to be
"somewhat" readable by a human.

A Key:


  • A Key is used when the actual value is important

  • A Key value might be kuali.org.School

  • A Key on occasion may be used or seen by an end
    user.

  • Keys are assumed to have the same values in different KS
    implementations

  • Key values are defined in configuration

  • Key values have significance in that they are referenced
    in Configuration

  • Key values are expected to be occasionally used in
    application code



Once an object is created with the specified key it cannot be
changed. Instead the object must be deleted or in-activated and
a new object created with the right key.		 Required on updates Read only on updates One Yes  
name Name String Friendly name of the State. Required   One No  
descr Description RichTextInfo Narrative description of the State.     One No  
lifecycleKey Lifecycle Key String The Lifecycle key to which this State belongs. Required Read only 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  
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