CourseOfferingDisplayInfo

Name CourseOfferingDisplayInfo
Usage CourseOfferingService
getCourseOfferingDisplay getCourseOfferingDisplaysByIds
Type Complex

Description

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  
courseId Course Id String A unique identifier assigned to all approved courses that exist
in the catalog This is not updatable once initialized.		 Required Read only One No this maps the the version dependent id as the offering
must point to one and only one version of the
course. Maps to cluId in Lui.
termId Term Id String Academic term of course offering Required Read only One No set during the #createCourseOffering and then maps to
the aptKey on the Lui
courseOfferingCode Course Offering Code String Identifies the number of a course as reflected in the course catalog.
This typically must be unique across all courses offered during that
term. If the user wants to create two separate offerings for the same
course they must modify this code to make it unique. For example: An
on-line offering of the course might have an "O" appended to it to
distinguish it from the face to face offering, i.e. ENG101 and ENG101O
Initially copied from the course catalog but then, depending on the
configuration it may be updatable. Often this field is configured so that
it is not not directly updatable but rather is calculated from it's two
constituent parts, the subject area and the course number suffix. For
example: Subject Area = "ENG" and Suffix = "101" then code = "ENG101"		   Read only One No  
courseOfferingTitle Course Title String Name of the course used in the college catalog. Initially copied from the
course catalog but then, depending on the configuration it may be
updatable. For regular courses this is not generally allowed to be
updated on the offering, but for special topics courses this is often
overridden to capture the particular topic being taught offered this
term. Note: the configuration of the validation for titles is typically
restricted to exclude line breaks. This may have to be loosened as some
schools may want the particular topic to appear on a 2nd line. For
example: SPECIAL TOPICS: AN EXPLORATION OF DEEP SPACE ARTIFACTS		   Read only \ One No  
subjectArea Subject Area String Identifies the department and/subject code of the course as reflected in
the course catalog. Initially copied from the course catalog but then,
depending on the configuration it may be updatable. In most
configurations this should not be updatable. Often used in the
calculation of the courseCode		   Read only One No  
termName Term Name String Name of the Term the Course Offering is in   Read only on updates One No  
termCode Term Code String Code for the term the course offering is in   Read only on updates One No  
displayGrading Display Grading String The display value of the grading options, this is derived by fetching the result value groups for the grading option tied
to the course offering and concatenating the values of the options.		   Read only on updates One No Get the credit option values and concatenate to a single field
displayCredit Display Credit String The display value of the credit, this is derived by fetching the result value groups for the credit option tied
to the course offering and concatenating the values of the options.		   Read only on updates One No Get the credit option values and concatenate to a single field
typeName Type name String The name of the Type that the Course Offering or the underlying LUI
is of.		   Read only on updates One No Name of the type the CO Info is of, read from TypeInfo object
stateName State Name Owner String The name of the State that the Course Offering or the underlying LUI
is in.		   Read only on updates One No Name of the state the CO Info is in, read from StateInfo object
activtyOfferingTypes Actvity Offering Types StringList Activty offering types for the course offering   Read only on updates Many No Get the format offering for the course offering and then the activity types from the Format offering
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