Course
A Course represents a canonical
course that manages the curriculum of learning units.
A Course is composed of
ActivityUnits that manage the details of
the curriculum and instantiated for offering through
the creation of a CourseOffering.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
title |
displaytext | the course title | |
number |
string | the course number | |
hasSponsors |
boolean | true if this course has sponsors, false
otherwise |
|
sponsorIds |
id | ⋆ | the sponsor Ids |
sponsors |
Resource | ⋆ | the sponsors |
creditAmountIds |
id | ⋆ | the grade Ids |
creditAmounts |
Grade | ⋆ | the credits |
prerequisitesInfo |
displaytext | the course prerequisites | |
hasPrerequisites |
boolean | true if this course has prerequisites false
otherwise |
|
prerequisiteIds |
id | ⋆ | the requisite Ids |
prerequisites |
Requisite | ⋆ | the requisites |
concurrentCourseIds |
id | ⋆ | the list of concurrent course Ids |
concurrentCourses |
Course | ⋆ | the list of concurrent courses |
levelIds |
id | ⋆ | the returned list of grade level Ids |
levels |
Grade | ⋆ | the returned list of grade levels |
isGraded |
boolean | true if this course is graded, false otherwise |
|
gradingOptionIds |
id | ⋆ | the returned list of grading option Ids |
gradingOptions |
GradeSystem | ⋆ | the returned list of grading options |
hasLearningObjectives |
boolean | true if this course has a learning objective,
false otherwise |
|
learningObjectiveIds |
id | ⋆ | Ids of the l earning objectives |
learningObjectives |
Objective | ⋆ | the learning objectives |
hasTargetAudiences |
boolean | true if this course has a target audience, false
otherwise |
|
targetAudienceIds |
id | ⋆ | the target audience Ids |
targetAudiences |
Resource | ⋆ | the target audiences |
Activity Unit
An ActivityUnit represents a
canonical learning unit. A canonical learning unit
describes a kind of activity that will be offered and
is used for curriculum planning.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
courseId |
id | the course Id |
|
course |
Course | the course | |
totalTargetEffort |
duration | the total effort | |
isContact |
boolean | true if this is a contact activity, false if an
independent activity |
|
totalTargetContactTime |
duration | the total effort | |
totalTargetIndividualEffort |
duration | the total individual effort | |
isRecurringWeekly |
boolean | true if this activity is recurring, false
otherwise |
|
weeklyEffort |
duration | the weekly time | |
weeklyContactTime |
duration | the weekly time | |
weeklyIndividualEffort |
duration | the weekly time | |
hasLearningObjectives |
boolean | true if this activity unit has a learning objective,
false otherwise |
|
learningObjectiveIds |
id | ⋆ | Ids of the l earning objectives |
learningObjectives |
Objective | ⋆ | the learning objectives |
Course Offering
A CourseOffering represents a
learning unit offered duing a Term.
Scheduling information of a
CourseOffering is maintained at the
Activity level resulting in a composite
RecurringEvent. A separate
Calendar of activities can be made
available through orchestration of the Calendaring
OSID.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
courseId |
id | the course Id |
|
course |
Course | the course | |
termId |
id | the Term Id |
|
term |
Term | the term | |
title |
displaytext | the course title | |
number |
string | the course number | |
instructorIds |
id | ⋆ | the instructor Ids |
instructors |
Resource | ⋆ | the sponsors |
hasSponsors |
boolean | true if this course has sponsors, false
otherwise |
|
sponsorIds |
id | ⋆ | the sponsor Ids |
sponsors |
Resource | ⋆ | the sponsors |
creditAmountIds |
id | ⋆ | the grade Ids |
creditAmounts |
Grade | ⋆ | the credits |
prerequisitesInfo |
displaytext | the course prerequisites | |
hasPrerequisites |
boolean | true if this course offering has prerequisites
false otherwise |
|
prerequisiteIds |
id | ⋆ | the requisite Ids |
prerequisites |
Requisite | ⋆ | the requisites |
concurrentCourseIds |
id | ⋆ | the list of concurrent course Ids |
concurrentCourses |
Course | ⋆ | the list of concurrent courses |
levelIds |
id | ⋆ | the returned list of grade level Ids |
levels |
Grade | ⋆ | the returned list of grade levels |
isGraded |
boolean | true if this course is graded, false otherwise |
|
gradingOptionIds |
id | ⋆ | the returned list of grading option Ids |
gradingOptions |
GradeSystem | ⋆ | the returned list of grading options |
hasLearningObjectives |
boolean | true if this course offering has a learning objective,
false otherwise |
|
learningObjectiveIds |
id | ⋆ | Ids of the l earning objectives |
learningObjectives |
Objective | ⋆ | the learning objectives |
hasRestrictedAudiences |
boolean | true if this course offering has a restricted audience,
false otherwise |
|
restrictedAudienceIds |
id | ⋆ | the restricted audience Ids |
restrictedAudiences |
Resource | ⋆ | the restricted audiences |
requiresRegistration |
boolean | true if this course requires advance registration,
false otherwise |
|
minimumSeats |
cardinal | the minimum seats | |
isSeatingLimited |
boolean | true if this seating is limited, false otherwise |
|
maximumSeats |
cardinal | the maximum seats | |
uRL |
string | a URL string | |
scheduleInfo |
displaytext | the schedule info | |
hasEvent |
boolean | true if this course is graded, false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | an event |
Activity
An Activity represents a recurring
activity of a course offering.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
activityUnitId |
id | the activity unit Id |
|
activityUnit |
ActivityUnit | the activity unit | |
courseOfferingId |
id | the course offering Id |
|
courseOffering |
CourseOffering | the course offering | |
termId |
id | the Term Id |
|
term |
Term | the term | |
isImplicit |
boolean | true if this is an implicit activity, false if
an explicit activity |
|
scheduleIds |
id | ⋆ | the schedule Ids |
schedules |
Schedule | ⋆ | the schedules |
supersedingActivityIds |
id | ⋆ | the superseding activity Ids |
supersedingActivities |
Activity | ⋆ | the superseding activities |
specificMeetingTimes |
MeetingTime | ⋆ | a list of specific meeting times |
blackouts |
DateTimeInterval | ⋆ | the exceptions to the scheduled activity |
instructorIds |
id | ⋆ | the instructor Ids |
instructors |
Resource | ⋆ | the sponsors |
requiresRegistration |
boolean | true if this is a registration is required,
false otherwise |
|
minimumSeats |
cardinal | the minimum seats | |
isSeatingLimited |
boolean | true if this is a seating is limited, false
otherwise |
|
maximumSeats |
cardinal | the maximum seats | |
totalTargetEffort |
duration | the total effort | |
isContact |
boolean | true if this is a contact activity, false if an
independent activity |
|
totalTargetContactTime |
duration | the total effort | |
totalTargetIndividualEffort |
duration | the total individual effort | |
isRecurringWeekly |
boolean | true if this activity is recurring, false
otherwise |
|
weeklyEffort |
duration | the weekly time | |
weeklyContactTime |
duration | the weekly time | |
weeklyIndividualEffort |
duration | the weekly time |
Term
A Term represents a period of time in
which a course is offered. This Term
contains information on severel milestones that may
drive the behavior of schedules and registration.
These periods of time may be linked to the
Term in the Calendaring OSID to effect
the behavior of the RecurringEvents.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
displayLabel |
displaytext | the term label | |
hasOpenDate |
boolean | true if there is an open date associated with this term,
false otherwise |
|
openDate |
datetime | the open date | |
hasRegistrationPeriod |
boolean | true if there is a registration period associated with this
term, false otherwise |
|
registrationStart |
datetime | the start date | |
registrationEnd |
datetime | the end date | |
classesStart |
datetime | the start date | |
classesEnd |
datetime | the end date | |
hasAddDropDate |
boolean | true if there is an add/drop date associated with this term,
false otherwise |
|
addDate |
datetime | the add/drop date | |
dropDate |
datetime | the add/drop date | |
hasFinalExamPeriod |
boolean | true if there is a final exam period associated with this
term, false otherwise |
|
finalExamStart |
datetime | the start date | |
finalExamEnd |
datetime | the end date | |
hasCloseDate |
boolean | true if there is a close date associated with this term,
false otherwise |
|
closeDate |
datetime | the close date |
Course Catalog
A CourseCatalog represents a
collection of courses, course offerings and terms.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |