home

StateInfo

Name StateInfo
Usage StateService
getState getNextHappyState
Type Complex

Description

Describes the state of an object

Structure Definition

ShortName Name Type Description Cardinality XML Attribute?
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
 One Yes
name Name String Friendly name of the State One No
descr Description String Narrative description of the State One No
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
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