FormatOfferingInfo

Name FormatOfferingInfo
Usage CourseOfferingService
getFormatOffering getFormatOfferingsByCourseOffering createFormatOffering updateFormatOffering validateFormatOffering
Type Complex

Description

A Format Offering specifies the allowable Activity Offering Types
that may be offered.

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  
courseOfferingId Course Offering Id String The Course Offering Id to which this Format Offering belongs. Required Read only One No  
formatId Format Id String Canonical Format this Format Offering corresponds
to. Currently, this is optional and Format Offerings may not
directly map to any canonical Format.		     One No  
termId Term Id String Academic term the format is being offered in.

Same as course offering term or a nested term of course
offering.		 Required   One No map to Lui.getAtpId
shortName Short Name String The short name for this Format Offering, such as LC or LC/LB.     One No  
activityOfferingTypeKeys Activity Offering Types StringList Gets a list of Activity Offering Types within this Format
Offering.		     Many No  
gradeRosterLevelTypeKey Grade Roster Level Key String Key indicating the level at which grade rosters should be generated -
activity, format or course. TODO: define these types. TODO: add a service
method to get the list of types that can be put in this field.		     One No this should be a constrained the a list types generated from the
roster types from the generic type system.
finalExamLevelTypeKey Final Exam Level Type Key String Indicates what activity type does the final exam exist in     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