OSID - osid.offering.Offering Service Interface Definition

Interface	osid.offering.Offering
Implements	`osid.OsidRelationship`
Used By	`osid.offering.OfferingAdminSession`
	`osid.offering.OfferingList`
	`osid.offering.OfferingLookupSession`
	`osid.offering.Participant`
Description	An `Offering` is an `OsidRelationship` between a `CanonicalUnit` and a `TimePeriod`.
Method	getCanonicalUnitId
Description	Gets the `Id` of the canonical unit.
Return	`osid.id.Id`		the canonical unit `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnit
Description	Gets the canonical of this offering.
Return	`osid.offering.CanonicalUnit`		the canonical unit
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodId
Description	Gets the `Id` of the time period.
Return	`osid.id.Id`		the time period `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriod
Description	Gets the time period of this offering
Return	`osid.calendaring.TimePeriod`		the time period
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTitle
Description	Gets the title for this offering.
Return	`osid.locale.DisplayText`		the title
Compliance	`mandatory`		This method must be implemented.
Method	getCode
Description	Gets the code for this offering.
Return	`string`		the code
Compliance	`mandatory`		This method must be implemented.
Method	hasResults
Description	Tests if this offering has results when offered.
Return	`boolean`		`true` if this offering has results, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultOptionIds
Description	Gets the various result option `Ids` allowed for results.
Return	`osid.id.IdList`		the returned list of grading option `Ids`
Errors	ILLEGAL_STATE		`hasResults()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResultOptions
Description	Gets the various result options allowed for this offering.
Return	`osid.grading.GradeSystemList`		the returned list of grading options
Errors	ILLEGAL_STATE		`hasResults()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if this offering has sponsors.
Return	`boolean`		`true` if this offering has sponsors, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorIds
Description	Gets the sponsor `Ids`.
Return	`osid.id.IdList`		the sponsor `Ids`
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsors
Description	Gets the sponsors.
Return	`osid.resource.ResourceList`		the sponsors
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleIds
Description	Gets the schedule `Ids` associated with this offering.
Return	`osid.id.IdList`		the schedule `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSchedules
Description	Gets the schedules associated with this offering.
Return	`osid.calendaring.ScheduleList`		the schedules
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingRecord
Description	Gets the record corresponding to the given `Offering` record `Type`.This method is used to retrieve an object implementing the requested record. The `offeringRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(offeringRecordType)` is `true`.
Parameters	`osid.type.Type`	`offeringRecordType`	the type of offering record to retrieve
Return	`osid.offering.records.OfferingRecord`		the offering record
Errors	NULL_ARGUMENT		`offeringRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offeringRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.