OSID — Course Program Entities

Program

Osid Object

A Program represents a canonical program and instantiated for offering through the creation of a ProgramOffering.

Like all OsidObjects, Program is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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 program title
`number`	string		the program number
`hasSponsors`	boolean		`true` if this program has sponsors, `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors
`isPartOf`	boolean		`true` if this program has a parent `false` otherwise
`parentProgramId`	id		the parent program `Id`
`parentProgram`	Program		the parent program
`learningObjectiveIds`	id	⋆	the learning objective `Ids`
`learningObjectives`	Objective	⋆	the learning objectives
`hasTargetAudiences`	boolean		`true` if this program has a target audience, `false` otherwise
`targetAudienceIds`	id	⋆	the target audience `Ids`
`targetAudiences`	Resource	⋆	the target audiences
`completionRequirementsInfo`	displaytext		the program completion
`hasCompletionRequirements`	boolean		`true` if this program has a completion rule, `false` otherwise
`completionRequirementIds`	id	⋆	the completion requisite `Ids`
`completionRequirements`	Requisite	⋆	the completion requisites
`earnsCredentials`	boolean		`true` if this program earns credentials, `false` otherwise
`credentialIds`	id	⋆	the returned list of credential `Ids`
`credentials`	Credential	⋆	the returned list of credentials

Program Offering

Osid Relationship

A ProgramOffering represents a learning unit offered duing a Term. Scheduling information of a ProgramOffering 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.

Like all OsidObjects, ProgramOffering is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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
`programId`	id		the program `Id`
`program`	Program		the program
`termId`	id		the `Term` `Id`
`term`	Term		the term
`title`	displaytext		the program title
`number`	string		the program number
`hasSponsors`	boolean		`true` if this program offering has sponsors, `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors
`isPartOf`	boolean		`true` if this program offering has a parent, `false` otherwise
`parentProgramOfferingId`	id		the parent program offering `Id`
`parentProgramOffering`	ProgramOffering		the parent program offering
`learningObjectiveIds`	id	⋆	the learning objective `Ids`
`learningObjectives`	Objective	⋆	the learning objectives
`hasRestrictedAudiences`	boolean		`true` if this program offering has a restricted audience, `false` otherwise
`restrictedAudienceIds`	id	⋆	the restricted audience `Ids`
`restrictedAudiences`	Resource	⋆	the restricted audiences
`completionRequirementsInfo`	displaytext		the program completion
`hasCompletionRequirements`	boolean		`true` if this program has a completion rule, `false` otherwise
`completionRequirementIds`	id	⋆	the completion requisite `Ids`
`completionRequirements`	Requisite	⋆	the completion requisites
`earnsCredentials`	boolean		`true` if this program earns credentials, `false` otherwise
`credentialIds`	id	⋆	the returned list of credential `Ids`
`credentials`	Credential	⋆	the returned list of credentials
`requiresRegistration`	boolean		`true` if this progranm offering requires advance registration, `false` otherwise
`minimumSeats`	cardinal		the minimum seats
`maximumSeats`	cardinal		the maximum seats
`uRL`	string		a URL string

Credential

Osid Object

A Credential represents something awarded at program completion.

Like all OsidObjects, Credential is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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
`hasLifeTime`	boolean		`true` if this credential expires, `false` if permanent
`lifetime`	duration		the lifetime

Enrollment

Osid Relationship

An Enrollment is an OsidRelationship between a student and a ProgramOffering.

Like all OsidObjects, Enrollment is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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	Description
`programOfferingId`	id	the program offering `Id`
`programOffering`	ProgramOffering	the program offering
`studentId`	id	the `Resource` `Id`
`student`	Resource	the student
`isPartOf`	boolean	`true` if this enrollment has a parent, `false` otherwise
`parentEnrollmentId`	id	the parent enrollment `Id`
`parentEnrollment`	Enrollment	the parent enrollment

Course Program

Programs

ProgramOfferings

Enrollment

Credentials

Course Catalog Cataloging

Sub Packages

Program

Program Offering

Credential

Enrollment