home

TermInfo

Name TermInfo
Usage AcademicCalendarService
getTerm
Type Complex

Description

Information about a Term.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute?
startDate StartDate Date Date and time the term becomes effective. This does not provide
a bound on date ranges or milestones associated with this time
period, but instead indicates the time period proper. This is a
similar concept to the effective date on enumerated
values. When an end date has been specified, this field must be
less than or equal to the end date.		 One No
endDate EndDate Date Date and time the term becomes ineffective. This does not
provide a bound on date ranges or milestones associated with
this time period, but instead indicates the time period
proper. If specified, this must be greater than or equal to the
start date. If this field is not specified, then no end date
has been currently defined and should automatically be
considered greater than the effective date.		 One No
terms Terms TermInfoList Gets the Terms nested inside this Term. Many 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