KeyDateInfo

Name KeyDateInfo
Usage AcademicCalendarService
getKeyDate getKeyDatesByIds getKeyDatesForTerm getKeyDatesForTermByDate getImpactedKeyDates searchForKeyDates validateKeyDate createKeyDate updateKeyDate calculateKeyDate
Type Complex

Description

Information about a key date. A key date may represent a single
point in time or a range depending on the value of isDateRange().

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
isAllDay Is All Day Boolean Tests if this key date is an all day event. An all-day event
does not have a meaningful time component in the date.		 Required   One No  
isRelativeToKeyDate Is Relative To Key Date Boolean Tests if this KeyDate is relative to another KeyDate. Required   One No maps to isRelative
relativeAnchorKeyDateId Relative Anchor KeyDate Id String Gets the anchor KeyDate to which this KeyDate is relative.     One No maps to relativeAnchorMilestoneId
isDateRange Is Date Range Boolean Tests if this key date has a date range. Required   One No  
startDate Start Date Date The start date and time of the key date.     One No  
endDate End Date Date The end date and time of the key date. The end
date must be equal to or greater that the start.		     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