| Name | courseOfferingInfo |
|---|---|
| Label | Course Offering |
| JSTL Key | CourseOfferingInfo |
| Java Class | org.kuali.student.enrollment.courseoffering.dto.CourseOfferingInfo |
| Description | |
| Primary Key(s) | id |
| Field to use as the title (or name) | id |
| Field | Required? | DataType | Length | Short Label | Summary | Label | Description | Read Only, Dynamic, or Hidden | Default | Repeats? | Valid Characters | Lookup | Cross Field | Default Control |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | STRING | 1 to 36 | Id | The system assigned unique id to identify this Course Offering. | Course Offering ID |
The system assigned unique id to identify this Course Offering. 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:
|
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| courseId | required | STRING | 1 to 255 | Course Id | Course ID | A unique identifier assigned to all approved courses that exist in the catalog This is not updatable once initialized. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| termKey | required | STRING | 1 to 80 | Term Key | Term | Academic term of course offering |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
SelectControl | ||||||
| subjectArea | STRING | 1 to 255 | Subject Area | Subject Area | 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 |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | |||||||
| typeKey | required | STRING | 1 to 80 | Type Key | Unique identifier for the type of this course offering. | Type Key | Unique identifier for the type of this course offering. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| stateKey | required | STRING | 1 to 80 | State Key | Unique identifier for the state of this course offering. i.e. draft, submitted, approved, offered, canceled, etc | State Key | Unique identifier for the state of this course offering. i.e. draft, submitted, approved, offered, canceled, etc |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| courseOfferingCode | STRING | 1 to 80 | Course Offering Code | Identifies the number of a course as reflected in the course catalog. | Course Offering Code | 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" |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | ||||||
| courseNumberSuffix | STRING | 1 to 255 | Course Number Suffix | A suffix of the course number as reflected in the college catalog. | Course Number Suffix | A suffix of the course number as reflected in the college catalog. This is the "number" portion of the course code. Initially copied from the course catalog but then, depending on the configuration it may be updatable. This field is often configured to be updatable but the updates typically simply append something like an "O" for on-line to it to differentiate multiple course offerings for the same course. Often used in the calculation of the courseCode. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| courseTitle | STRING | 1 to 255 | Course Title | Name of the course used in the college catalog. | Course Title | 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 |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| isHonorsOffering | BOOLEAN | Is Honors Offering | Indicates that the entire course offering is an Honors Course ??? | Is Honors Offering | Indicates that the entire course offering is an Honors Course ??? Is this an enrollment restriction rule or a flag or both? | CheckboxControl | ||||||||
| hasFinalExam | BOOLEAN | Has Final Exam | Indicates whether a final exam is to be given Initially copied from the canonical course and then, depending on configuration, updated. | Has Final Exam | Indicates whether a final exam is to be given Initially copied from the canonical course and then, depending on configuration, updated. | CheckboxControl | ||||||||
| maximumEnrollment | INTEGER | 1 to 10 | Maximum Enrollment | Total maximum number of "seats" or enrollment slots that can be filled for the offering. | Maximum Enrollment | Total maximum number of "seats" or enrollment slots that can be filled for the offering. Calculated based on sum of all the maximum seats of primary activity type offerings. |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| minimumEnrollment | INTEGER | 1 to 10 | Minimum Enrollment | Total minimum number of seats that must be filled for the offering not to be canceled. | Minimum Enrollment | Total minimum number of seats that must be filled for the offering not to be canceled. Calculated based on sum of all the minimum seats of primary activity type offerings |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| gradeRosterLevelTypeKey | STRING | 1 to 255 | Grade Roster Level Type Key | Key indicating the level at which grade rosters should be generated - activity, format or course. | Grade Roster Level Key | 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. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| hasWaitlist | BOOLEAN | Has Waitlist | Indicates whether a RegistrationGroup has a waitlist TODO: figure out how to store this TODO: make sure we are consistent on how we spell Waitlist, should be spelled Waitlist, or Wait List or Wait-List (as the merriam-webster has it) | Has Waitlist | Indicates whether a RegistrationGroup has a waitlist TODO: figure out how to store this TODO: make sure we are consistent on how we spell Waitlist, should be spelled Waitlist, or Wait List or Wait-List (as the merriam-webster has it) | CheckboxControl | ||||||||
| waitlistTypeKey | STRING | 1 to 255 | Waitlist Type Key | Indicates the type of waitlist as it relates to processing students on and off The three types predefined in kuali are Automatic, Semi-Automatic and Manual TODO: Right not Waitlist types are not tied to any Waitlist object so we need to define an "other key" to get the list of valid values from the type service. | Waitlist Type Key | Indicates the type of waitlist as it relates to processing students on and off The three types predefined in kuali are Automatic, Semi-Automatic and Manual TODO: Right not Waitlist types are not tied to any Waitlist object so we need to define an "other key" to get the list of valid values from the type service. TODO: Decide if we need a separate getHasWaitList, perhaps no value in this field means no waitlist. TODO: Cross validate with hasWaitlist |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| waitlistMaximum | INTEGER | 1 to 10 | Waitlist Maximum | Maximum number of students to be allowed on the wait list | Waitlist Maximum | Maximum number of students to be allowed on the wait list |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| isWaitlistCheckinRequired | BOOLEAN | Is Waitlist Checkin Required | Indicates if the waitlist requires checkin | Is Waitlist Checkin Required | Indicates if the waitlist requires checkin | CheckboxControl | ||||||||
| fundingSource | STRING | 1 to 255 | Funding Source | The primary source of funding for the offering. | Funding Source | The primary source of funding for the offering. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| isFinancialAidEligible | BOOLEAN | Is Financial Aid Eligible | Flag indicating whether a course is eligible for Financial Aid. | Is Financial Aid Eligible | Flag indicating whether a course is eligible for Financial Aid. Derived from course catalog (canonical) TODO: find a place to store this on the canonical course because it does not currently exist there TODO: Decide if this is really a rule or a CluSet or what? | CheckboxControl | ||||||||
| registrationOrderTypeKey | STRING | 1 to 255 | Registration Order Type Key | Specifies whether the selection of RegistrationGroup that students register for will be done as a block (all activities together) or in a sequential order of activities The two types that have been predefined are "All" and "Sequenced": All: When a student registers for this course she gets registered for all sections identified by the reg. group Sequenced: When a student registers for this course she must register first for the primary section identified and then any secondary sections TODO: We have NOT fully figured out how to do sequences in course registration | Registration Order Type Key | Specifies whether the selection of RegistrationGroup that students register for will be done as a block (all activities together) or in a sequential order of activities The two types that have been predefined are "All" and "Sequenced": All: When a student registers for this course she gets registered for all sections identified by the reg. group Sequenced: When a student registers for this course she must register first for the primary section identified and then any secondary sections TODO: We have NOT fully figured out how to do sequences in course registration |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.key | required | STRING | 1 to 80 | Key | Unique Key used to identify this object | Unique Key | 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. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.typeKey | required | STRING | 1 to 80 | Type | Type of the object | Type | Unique identifier for the type of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.stateKey | required | STRING | 1 to 80 | State | State of the object | State | Unique identifier for the lifecycle state of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.name | STRING | 1 to 255 | Name | A display name for this entity. | Name | A display name for this entity. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultScaleKey | STRING | 1 to 255 | Result Scale Key | The scale to which this group belongs. | Result Scale Key | The scale to which this group belongs. Result Values mapped to a Result Values Group belong to a single Result Scale. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.effectiveDate | required | DATE | must be 19 | Effective | Effective Date | Effective Date | The date the object became (will become) effective | DateControl | ||||||
| creditOptions.expirationDate | DATE | must be 19 | Expires | Expiration Date | Expiration Date | The date the object became (will) expire | DateControl | |||||||
| creditOptions.descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.resultValueRange.minValue | STRING | 1 to 255 | Min Value | Min Result Value string Lower end of the value range. | Min Value | Min Result Value string Lower end of the value range. Typically corresponds with the short coded form of the result(ex. "1.0", "25.0" etc.) Should the data resultTypeKey of values (min/max) be numbers and not Strings in the value range? |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.maxValue | STRING | 1 to 255 | Max Value | Max Result Value string Upper end of the value range. | Max Value | Max Result Value string Upper end of the value range. Typically corresponds with the short coded form of the result(ex. "3.0", "100.0" etc.). Upper end can be left empty to indicate unbounded upper end. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.increment | STRING | 1 to 255 | Increment | Increment number Legal increments in the result values. | Increment | Increment number Legal increments in the result values. This has to be a decimal e.g 0.5) |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| creditOptions.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| creditOptions.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| expenditure.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| expenditure.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| waitlistCheckinFrequency.atpDurationTypeKey | STRING | 1 to 255 | Atp Duration Type Key | The kind of units associated with the quantity, such as Semesters | Academic Time Period Duration Type Key | The kind of units associated with the quantity, such as Semesters |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| waitlistCheckinFrequency.timeQuantity | INTEGER | 1 to 10 | Time Quantity | The amount of time | Time Quantity | The amount of time |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| descr | Complex | Descr | A description of this Course Offering. | Description | A description of this Course Offering. This starts out the same as the canonical description from the catalog but then, depending on the configuration, it may be overwritten, changed, or expanded upon. | |||||||||
| descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions | Complex | Credit Options | Type of credit of course offering. | Credit Options | Type of credit of course offering. This field is initially copied from the canonical course but then, depending on configuration, it may be updated. TODO: figure out which of the credit options will be copied down because the canonical has more than one! Often it is just a fixed single value but a ResultValuesGroup could contain a range (with increments) or even a discrete list of possible credit values. | |||||||||
| creditOptions.key | required | STRING | 1 to 80 | Key | Unique Key used to identify this object | Unique Key | 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. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.typeKey | required | STRING | 1 to 80 | Type | Type of the object | Type | Unique identifier for the type of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.stateKey | required | STRING | 1 to 80 | State | State of the object | State | Unique identifier for the lifecycle state of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| creditOptions.name | STRING | 1 to 255 | Name | A display name for this entity. | Name | A display name for this entity. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultScaleKey | STRING | 1 to 255 | Result Scale Key | The scale to which this group belongs. | Result Scale Key | The scale to which this group belongs. Result Values mapped to a Result Values Group belong to a single Result Scale. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.effectiveDate | required | DATE | must be 19 | Effective | Effective Date | Effective Date | The date the object became (will become) effective | DateControl | ||||||
| creditOptions.expirationDate | DATE | must be 19 | Expires | Expiration Date | Expiration Date | The date the object became (will) expire | DateControl | |||||||
| creditOptions.descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.resultValueRange.minValue | STRING | 1 to 255 | Min Value | Min Result Value string Lower end of the value range. | Min Value | Min Result Value string Lower end of the value range. Typically corresponds with the short coded form of the result(ex. "1.0", "25.0" etc.) Should the data resultTypeKey of values (min/max) be numbers and not Strings in the value range? |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.maxValue | STRING | 1 to 255 | Max Value | Max Result Value string Upper end of the value range. | Max Value | Max Result Value string Upper end of the value range. Typically corresponds with the short coded form of the result(ex. "3.0", "100.0" etc.). Upper end can be left empty to indicate unbounded upper end. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.increment | STRING | 1 to 255 | Increment | Increment number Legal increments in the result values. | Increment | Increment number Legal increments in the result values. This has to be a decimal e.g 0.5) |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| creditOptions.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| creditOptions.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.descr | Complex | Descr | A description of the entity. | Description | A description of the entity. | |||||||||
| creditOptions.descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| creditOptions.resultValueRange | Complex | Result Value Range | The range contained within this result value group. | Result Value Range | The range contained within this result value group. This is optional and might not be present for some Result Components | |||||||||
| creditOptions.resultValueRange.minValue | STRING | 1 to 255 | Min Value | Min Result Value string Lower end of the value range. | Min Value | Min Result Value string Lower end of the value range. Typically corresponds with the short coded form of the result(ex. "1.0", "25.0" etc.) Should the data resultTypeKey of values (min/max) be numbers and not Strings in the value range? |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.maxValue | STRING | 1 to 255 | Max Value | Max Result Value string Upper end of the value range. | Max Value | Max Result Value string Upper end of the value range. Typically corresponds with the short coded form of the result(ex. "3.0", "100.0" etc.). Upper end can be left empty to indicate unbounded upper end. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.resultValueRange.increment | STRING | 1 to 255 | Increment | Increment number Legal increments in the result values. | Increment | Increment number Legal increments in the result values. This has to be a decimal e.g 0.5) |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| creditOptions.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| creditOptions.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| creditOptions.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| creditOptions.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure | Complex | Expenditure | Organization(s) that incurs the cost associated with the course offering Initially copied from the course catalog but then, depending on the configuration it may be updatable. | Expenditure | Organization(s) that incurs the cost associated with the course offering Initially copied from the course catalog but then, depending on the configuration it may be updatable. | |||||||||
| expenditure.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| expenditure.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| expenditure.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| expenditure.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| expenditure.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| expenditure.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.affiliatedOrgs | Complex | Affiliated Orgs | List of affiliated organizations. | Affiliated Organizations | List of affiliated organizations. | Repeating | ||||||||
| expenditure.affiliatedOrgs.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.affiliatedOrgs.orgId | STRING | 1 to 36 | Org Id | Unique identifier for an organization. | Organization Id | Unique identifier for an organization. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| expenditure.affiliatedOrgs.percentage | LONG | 1 to 10 | Percentage | A long numeric value without a fractional component. | Percentage | A long numeric value without a fractional component. |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| expenditure.affiliatedOrgs.effectiveDate | required | DATE | must be 19 | Effective | Effective Date | Effective Date | The date the object became (will become) effective | DateControl | ||||||
| expenditure.affiliatedOrgs.expirationDate | DATE | must be 19 | Expires | Expiration Date | Expiration Date | The date the object became (will) expire | DateControl | |||||||
| waitlistCheckinFrequency | Complex | Waitlist Checkin Frequency | Frequency for the waitlist checkin | Waitlist Checkin Frequency | Frequency for the waitlist checkin | |||||||||
| waitlistCheckinFrequency.atpDurationTypeKey | STRING | 1 to 255 | Atp Duration Type Key | The kind of units associated with the quantity, such as Semesters | Academic Time Period Duration Type Key | The kind of units associated with the quantity, such as Semesters |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| waitlistCheckinFrequency.timeQuantity | INTEGER | 1 to 10 | Time Quantity | The amount of time | Time Quantity | The amount of time |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors | Complex | Instructors | Instructors for this course offering TODO: find out if the canonical instructors should be copied down | Instructors | Instructors for this course offering TODO: find out if the canonical instructors should be copied down | Repeating | ||||||||
| instructors.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.personId | STRING | 1 to 36 | Person Id | Unique identifier for a person record. | Person Id | Unique identifier for a person record. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.percentageEffort | FLOAT | 1 to 10 | Percentage Effort | Percentage involvement of the instructor in the | Percentage Effort | Percentage involvement of the instructor in the |
validation.validChars.numeric ^[-]?([1-9]{1}[0-9]{0,}(\.[0-9]{0,2})?|0(\.[0-9]{0,2})?|\.[0-9]{1,2})$ |
CurrencyControl | ||||||
| instructors.typeKey | required | STRING | 1 to 80 | Type | Type of the object | Type | Unique identifier for the type of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| instructors.stateKey | required | STRING | 1 to 80 | State | State of the object | State | Unique identifier for the lifecycle state of this object. |
validation.validChars.alphanumericHyphenPeriod [A-Za-z0-9.\-]* |
TextControl | |||||
| instructors.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| instructors.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| instructors.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| instructors.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| instructors.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| instructors.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| instructors.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees | Complex | Fees | Fees associated with the course offering. | Fees | Fees associated with the course offering. Initially copied from the course catalog but then, depending on the configuration it may be updatable. | Repeating | ||||||||
| fees.feeType | STRING | 1 to 255 | Fee Type | A code that identifies the type of the fee. | Fee Type | A code that identifies the type of the fee. For example: Lab Fee or Tuition Fee or CMF for Course Materials Fee. From a program perspective it may be an application fee. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.rateType | STRING | 1 to 255 | Rate Type | Indicates the structure and interpretation of the fee amounts, i.e. | Rate Type | Indicates the structure and interpretation of the fee amounts, i.e. Fixed, Variable, Multiple. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| fees.descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| fees.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| fees.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| fees.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.descr | Complex | Descr | Narrative description of the Fee. | Description | Narrative description of the Fee. | |||||||||
| fees.descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| fees.descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t\n\r ]* |
TextAreaControl | ||||||
| fees.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| fees.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| fees.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| fees.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts | Complex | Fee Amounts | The amount or amounts associated with the fee. | Fee Amounts | The amount or amounts associated with the fee. The number fee amounts and interpretation depends on the rate type. | Repeating | ||||||||
| fees.feeAmounts.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.currencyTypeKey | STRING | 1 to 255 | Currency Type Key | The kind of units associated with the quantity, such as US Dollars | Currency Type Key | The kind of units associated with the quantity, such as US Dollars |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.currencyQuantity | INTEGER | 1 to 10 | Currency Quantity | The amount of currency | Currency Quantity | The amount of currency |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| fees.feeAmounts.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| fees.feeAmounts.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| fees.feeAmounts.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| fees.feeAmounts.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| fees.feeAmounts.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| fees.feeAmounts.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| fees.feeAmounts.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues | Complex | Revenues | Organization(s) that receives the revenue from fees associated with the course offering Initially copied from the course catalog but then, depending on the configuration it may be updatable. | Revenues | Organization(s) that receives the revenue from fees associated with the course offering Initially copied from the course catalog but then, depending on the configuration it may be updatable. | Repeating | ||||||||
| revenues.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.feeType | STRING | 1 to 255 | Fee Type | The fee type that identifies the revenue to be distributed. | Fee Type | The fee type that identifies the revenue to be distributed. A code that identifies the type of the fee. For example: Lab Fee or Tuition Fee or CMF for Course Materials Fee. From a program perspective it may be an application fee. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| revenues.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| revenues.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| revenues.meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| revenues.meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| revenues.meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.affiliatedOrgs | Complex | Affiliated Orgs | List of affiliated organizations. | Affiliated Organizations | List of affiliated organizations. | Repeating | ||||||||
| revenues.affiliatedOrgs.id | STRING | 1 to 36 | ID | Unique ID assigned to this object | Identifier | The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.affiliatedOrgs.orgId | STRING | 1 to 36 | Org Id | Unique identifier for an organization. | Organization Id | Unique identifier for an organization. |
validation.validChars [A-Za-z0-9.,><_\\/\-\?\+=()\[\];:'"&%$#@!\t ]* |
TextControl | ||||||
| revenues.affiliatedOrgs.percentage | LONG | 1 to 10 | Percentage | A long numeric value without a fractional component. | Percentage | A long numeric value without a fractional component. |
validation.validChars.positive.integer [1-9][0-9]* |
TextControl | ||||||
| revenues.affiliatedOrgs.effectiveDate | required | DATE | must be 19 | Effective | Effective Date | Effective Date | The date the object became (will become) effective | DateControl | ||||||
| revenues.affiliatedOrgs.expirationDate | DATE | must be 19 | Expires | Expiration Date | Expiration Date | The date the object became (will) expire | DateControl |