OSID — Offering Entities

Canonical Unit

Osid Object

A Canonical Unit is an approved item to be offered.

Like all OsidObjects, CanonicalUnit 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 title
`code`	string		the code
`offeredCyclicTimePeriodIds`	id	⋆	a list of cyclic period `Ids`
`offeredCyclicTimePeriods`	CyclicTimePeriod	⋆	a list of cyclic periods
`hasResults`	boolean		`true` if this canonical has results, `false` otherwise
`resultOptionIds`	id	⋆	the returned list of grading option `Ids`
`resultOptions`	GradeSystem	⋆	the returned list of grading options
`hasSponsors`	boolean		`true` if this canonical has sponsors, `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors

Offering

Osid Relationship

An Offering is an OsidRelationship between a CanonicalUnit and a TimePeriod.

Like all OsidObjects, Offering 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
`canonicalUnitId`	id		the canonical unit `Id`
`canonicalUnit`	CanonicalUnit		the canonical unit
`timePeriodId`	id		the time period `Id`
`timePeriod`	TimePeriod		the time period
`title`	displaytext		the title
`code`	string		the code
`hasResults`	boolean		`true` if this offering has results, `false` otherwise
`resultOptionIds`	id	⋆	the returned list of grading option `Ids`
`resultOptions`	GradeSystem	⋆	the returned list of grading options
`hasSponsors`	boolean		`true` if this offering has sponsors, `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors
`scheduleIds`	id	⋆	the schedule `Ids`
`schedules`	Schedule	⋆	the schedules

Participant

Osid Relationship

A Participant in an OsidRelationship between an Offering and a Resource.

Like all OsidObjects, Participant 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
`offeringId`	id		the `Offering` `Id`
`offering`	Offering		the `Offering`
`resourceId`	id		the `Resource` `Id`
`resource`	Resource		the `Resource`
`timePeriodId`	id		the `TimePeriod` `Id`
`timePeriod`	TimePeriod		the `TimePeriod`
`hasResults`	boolean		`true` if there are results, `false` otherwise
`resultOptionIds`	id	⋆	the returned list of grading option `Ids`
`resultOptions`	GradeSystem	⋆	the returned list of grading options

Result

Osid Object Subjugateable

A Result is an outcome from a Participation.

Like all OsidObjects, Result 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

Name	Syntax	Description
`participantId`	id	the `Participant` `Id`
`participant`	Participant	the `Participant`
`isGraded`	boolean	`true` if a grade has been assigned, `false` otherwise
`gradeId`	id	the grade `Id`
`grade`	Grade	the grade
`value`	decimal	the value

Catalogue

Osid Catalog

A Catalogue represents a collection of canonical units and offerings. Like all OsidObjects, a Catalogue is identified by its Id and any persisted references should use the Id.

Like all OsidObjects, Catalogue 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
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

Offering

Offering

CanonincalUnit

Participant

Result

Example

Catalogue Cataloging

Sub Packages

Canonical Unit

Offering

Participant

Result

Catalogue