home dictionary doc

CampusCalendarInfo

Name CampusCalendarInfo
Usage AcademicCalendarService
getCampusCalendar getCampusCalendarsByKeyList getCampusCalendarsByStartYear searchForCampusCalendars validateCampusCalendar createCampusCalendar updateCampusCalendar
Type Complex

Description

Information about a Campus Calendar.

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  
typeKey Type Key String Unique identifier for the type of this object. Required Read only on updates One Yes  
stateKey State Key String 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  
startDate Start Date Date Date and time the campus calendar became 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 expiration date has been
specified, this field must be less than or equal to the
expiration date.		     One No  
endDate End Date Date Date and time the campus calendar expires. 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
effective date. If this field is not specified, then no
expiration date has been currently defined and should
automatically be considered greater than the effective date.		     One No  
location Location String The campus or location to which this calendar pertains.     One No  
meta 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.		 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