OSID - osid.course.program.ProgramOffering Service Interface Definition

Interface	osid.course.program.ProgramOffering
Implements	`osid.OsidRelationship`
Used By	`osid.course.program.Enrollment`
	`osid.course.program.ProgramOffering`
	`osid.course.program.ProgramOfferingAdminSession`
	`osid.course.program.ProgramOfferingList`
	`osid.course.program.ProgramOfferingLookupSession`
Description	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.
Method	getProgramId
Description	Gets the canonical program `Id` associated with this program offering.
Return	`osid.id.Id`		the program `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProgram
Description	Gets the canonical program associated with this program offering.
Return	`osid.course.program.Program`		the program
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTermId
Description	Gets the `Id` of the `Term` of this offering.
Return	`osid.id.Id`		the `Term` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTerm
Description	Gets the `Term` of this offering.
Return	`osid.course.Term`		the term
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTitle
Description	Gets the formal title of this program offering. It may be the same as the display name or it may be used to more formally label the program. A display name might be Course 16 where the title is Aeronautics & Astronautics.
Return	`osid.locale.DisplayText`		the program title
Compliance	`mandatory`		This method must be implemented.
Method	getNumber
Description	Gets the program number which is a label generally used to index the program offering in a catalog, such as 16.
Return	`string`		the program number
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if this program offering has sponsors.
Return	`boolean`		`true` if this program 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	isPartOf
Description	Tests if this program offering is part of another program offering.
Return	`boolean`		`true` if this program offering has a parent, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramOfferingId
Description	Gets the `Id` for the parent program offering.
Return	`osid.id.Id`		the parent program offering `Id`
Errors	ILLEGAL_STATE		`isPartOf()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramOffering
Description	Gets the parent program offering.
Return	`osid.course.program.ProgramOffering`		the parent program offering
Errors	ILLEGAL_STATE		`isPartOf()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveIds
Description	Gets the `Objective` `Ids` for the program.
Return	`osid.id.IdList`		the learning objective `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectives
Description	Gets the learning objectives for the program.
Return	`osid.learning.ObjectiveList`		the learning objectives
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasRestrictedAudiences
Description	Tests if this program offering has restricted audiences.
Return	`boolean`		`true` if this program offering has a restricted audience, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRestrictedAudienceIds
Description	Gets the restricted audience `Ids` for this program offering.
Return	`osid.id.IdList`		the restricted audience `Ids`
Errors	ILLEGAL_STATE		`hasRestrictedAudiences()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRestrictedAudiences
Description	Gets the restricted audiences for this program offering.
Return	`osid.resource.ResourceList`		the restricted audiences
Errors	ILLEGAL_STATE		`hasRestrictedAudiences()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirementsInfo
Description	Gets the an informational string for the program completion.
Return	`osid.locale.DisplayText`		the program completion
Compliance	`mandatory`		This method must be implemented.
Method	hasCompletionRequirements
Description	Tests if this program has a rule for the program completion.
Return	`boolean`		`true` if this program has a completion rule, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirementIds
Description	Gets the `Requisite` `Ids` for the program completion.
Return	`osid.id.IdList`		the completion requisite `Ids`
Errors	ILLEGAL_STATE		`hasCompletionRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirements
Description	Gets the requisites for the program completion. Each `Requisite` is an `AND` term and must be true for the requirements to be satisifed.
Return	`osid.course.requisite.RequisiteList`		the completion requisites
Errors	ILLEGAL_STATE		`hasCompletionRequirements()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	earnsCredentials
Description	Tests if completion of this program results in credentials awarded.
Return	`boolean`		`true` if this program earns credentials, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialIds
Description	Gets the awarded credential `Ids`.
Return	`osid.id.IdList`		the returned list of credential `Ids`
Errors	ILLEGAL_STATE		`earnsCredentials()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentials
Description	Gets the awarded credentials.
Return	`osid.course.program.CredentialList`		the returned list of credentials
Errors	ILLEGAL_STATE		`earnsCredentials()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresRegistration
Description	Tests if this program offering requires advanced registration.
Return	`boolean`		`true` if this progranm offering requires advance registration, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumSeats
Description	Gets the minimum number of students this offering can have.
Return	`cardinal`		the minimum seats
Errors	ILLEGAL_STATE		`requiresRegistration()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumSeats
Description	Gets the maximum number of students this offering can have.
Return	`cardinal`		the maximum seats
Errors	ILLEGAL_STATE		`requiresRegistration()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getURL
Description	Gets an external resource, such as a class web site, associated with this offering.
Return	`string`		a URL string
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingRecord
Description	Gets the program offering record corresponding to the given `ProgramOffering` record `Type`. This method is used to retrieve an object implementing the requested record. The `programOfferingRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(programOfferingRecordType)` is `true`.
Parameters	`osid.type.Type`	`programOfferingRecordType`	the type of program offering record to retrieve
Return	`osid.course.program.records.ProgramOfferingRecord`		the program offering record
Errors	NULL_ARGUMENT		`programOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programOfferingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.