home

KeyDateInfo

Name KeyDateInfo
Usage AcademicCalendarService
getKeyDate validateKeyDate createKeyDateForTerm createKeyDateForCampusCalendar updateKeyDate
Type Complex

Description

Information about a key date.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute?
isDateRange IsDateRange Boolean Tests if this keyDate has a date range. If true, the end date
value follows the start date.		 One No
startDate StartDate Date Gets the start Date and time of the keyDate. One No
endDate EndDate Date Gets the end Date and time of the keyDate. One No
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 A display name for this entity. One No
descr Description RichTextInfo A description of the entity. One No
typeKey Type Key String Unique identifier for the type of this object. One Yes
stateKey State Key String Unique identifier for the state of this object. One Yes
metaInfo Create/Update meta info 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.		 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