| Name | ActivityOfferingDisplayInfo | |
|---|---|---|
| Usage | CourseOfferingService | |
| getActivityOfferingDisplay getActivityOfferingDisplaysByIds getActivityOfferingDisplaysForCourseOffering | ||
| Type | Complex | |
| 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:
|
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 | |||
| typeName | Activity Offering Type Display Name | String | A display name for the Activity Offering Type. | Read only | One | No | ActivityOffering.Type.Name | |
| stateName | Activity Offering State Display Name | String | A display name for the activity Offering State. | Read only | One | No | ActivityOffering.State.Name | |
| courseOfferingTitle | Course Offering 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 | ActivityOffering.FormatOffering.CourseOffering.Title | |
| 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 | ActivityOffering.FormatOffering.CourseOffering.CourseOfferingCode | |
| formatOfferingId | Format Offering Id | String | The Format Offering Id used to create this ActivityOffering. | Read only | One | No | ActivityOffering.FormatOffering.Id | |
| formatOfferingName | Format Offering Display Name | String | A display name for the Format Offering. | Read only | One | No | ActivityOffering.FormatOffering.Name | |
| activityOfferingCode | Activity Offering Code | String | Alphanumeric character that identifies the section of the course offering. |
Read only | One | No | ActivityOffering.ActivityOfferingCode | |
| instructorId | Instructor Id | String | Gets the instructor of record for this ActivityOffering. | Read only | One | No | ActivityOffering.OfferingInstructor.PersonId | |
| instructorName | Instructor Display Name | String | Gets the name of the instructor of record for this ActivityOffering. |
Read only | One | No | ActivityOffering.OfferingInstructor.Person.name | |
| isHonorsOffering | Is Honors Offering | Boolean | Indicates that the Activity Offering is an Honors option | Read only | One | No | 'H' icon displayed if true | |
| location | Location | String | The building and room location | Read only | One | No | "BAG 291A" | |
| scheduleWeekdays | Schedule Display Weekdays | String | Gets a display string represnting the weekday pattern using characters. |
Read only | One | No | if unscheduled, this string is built from all of related ScheduleRequest.ScheduleComponents.TimeSlots.Weekdays If there is more than one related ScheduleRequest, then use the most recent active one (the one that will be sent to the scheduler). if scheduled, then use ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Weekdays |
|
| scheduleTime | Schedule Display Time | String | Gets a display string represnting the time and duration. | Read only | One | No | if unscheduled, this string is built from all of related ScheduleRequest.ScheduleComponents.TimeSlots.StartTime and ScheduleRequest.ScheduleComponents.TimeSlots.Duration and If there is more than one related ScheduleRequest, then use the most recent active one (the one that will be sent to the scheduler). if scheduled, then use ActivityOffering.Schedule.ScheduleComponents.TimeSlots.StartTime and ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Duration |
|
| 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 |