home dictionary doc

StateProcessInfo

Name StateProcessInfo
Usage StateService
getProcessByKey
Type Complex

Description

Detailed Information about a State Process

State Process are used in Kuali Student to define various process keys that might be associated with objectTypes
For example: A course might have a lifecycle process or workflow process with different states in each process

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 Read only on updates One Yes  
name Name String Friendly name of the State Process Required Read only One No  
descr Description String Narrative description of the State Process   Read only 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