CourseInfo

Name CourseInfo
Usage CourseService
getCourse getCoursesByIds searchForCourses createCourse updateCourse validateCourse createNewCourseVersion
Type Complex

Description

This is a description of what this class does - sambit don't forget to fill
this in.

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  
code code String Identifier used to officially reference or publish the
course.

The code is typically unique within a specified context or time period but
it is not intended as a database key or id.

It may have an internal structure that each Institution may
want to enforce. This structure may be composed from the other parts of
the structure such as Level amp; Division, but may include items such as
the type of the course and whether it has a lab or not.		     One No  
courseNumberSuffix Course Number Suffix String The "extra" portion of the code, which usually corresponds with the most
detailed part of the number. Ex. at MIT we might map Division to subject
area(Ex:6) but overall we need to say the code is 6.120. This field would
represent the 120 part.		     One No  
level Level String A code that indicates what level 100, 200 or upper division, lower
division etc		     One No  
courseTitle Course Title String Abbreviated name of the Course     One No  
transcriptTitle Transcript Title String Information related to the official identification of the credit course,
typically in human readable form. Used to officially reference or
publish.		     One No  
formats Formats FormatInfoList Course Formats     Many No  
termsOffered Terms Offered StringList Terms in which this Course is typically offered.     Many No  
duration Duration TimeAmountInfo The standard duration of the Course.     One No  
joints Joints CourseJointInfoList Joint Courses     Many No  
crossListings Cross Listings CourseCrossListingInfoList Cross Listed Courses     Many No  
variations Variations CourseVariationInfoList Variations     Many No  
subjectArea Subject Area String The Study Subject Area is used to identify the area of study associated
with the course. It may be a general study area (e.g. Chemistry) or very
specific (e.g. Naval Architecture).		     One No  
campusLocations Campus Locations StringList Places where this course might be offered     Many No  
outOfClassHours Out of Class Hours AmountInfo The expected level of out of class time commitment between the student
and the course.		     One No  
primaryInstructor Primary Instructor CluInstructorInfo Primary potential instructor for the course. This is primarily for use in
advertising the course and may not be the actual instructor.		     One No  
instructors Instructors CluInstructorInfoList Instructors associated with this course.     Many No  
unitsDeployment Units Deployment StringList Units Responsible for Deploying this course     Many No  
feeJustification Fee Justification RichTextInfo Narrative description of overall course fee justification.     One No  
unitsContentOwner Units Content Owner StringList Units Responsible for overseeing the content of this course     Many No  
fees Fees CourseFeeInfoList Fees information associated with this Course.     Many No  
revenues Revenues CourseRevenueInfoList Revenue information associated with this Course.     Many No  
expenditure Expenditure CourseExpenditureInfo Expenditure information associated with this Course.     One No  
courseSpecificLOs Course Specific Learning Objectives LoDisplayInfoList Learning Objectives associated with this Course.     Many No  
gradingOptions Grading Options StringList Grading options available for the course     Many No  
creditOptions Credit Options ResultValuesGroupInfoList Credit outcomes from taking the course     Many No  
specialTopicsCourse Special Topics Course? boolean Flag to indicate the course as a special topics course     One No  
pilotCourse Pilot Course? boolean Flag to indicate a one-time or pilot course, which is likely to have
expedited approval process		     One No  
startTerm Start Term String The first academic time period that this Course would be effective.     One No  
endTerm End Term String The last academic time period that this Course would be effective.     One No  
effectiveDate Effective Date Date Date and time the Course became effective. 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  
expirationDate Expiration Date Date Date and time that this Course expires. This is a similar concept to the
expiration date on enumerated values. If specified, this should 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  
versionInfo Version VersionInfo Version of this course     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