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

Interface	osid.course.program.Program
Implements	`osid.OsidObject`
Implements	`osid.Operable`
Description	A `Program` represents a canonical program and instantiated for offering through the creation of a `ProgramOffering.`
Method	getTitle
Description	Gets the formal title of this program. It may be the same as the display name or it may be used to more formally label the program. 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 in a catalog, such as "16c."
Return	`string`		the program number
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if this program has sponsors.
Return	`boolean`		`true` if this program 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	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	getProgramRecord
Description	Gets the program record corresponding to the given `Program` record `Type.` This method is used to retrieve an object implementing the requested record. The `programRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(programRecordType)` is `true` .
Parameters	`osid.type.Type`	`programRecordType`	the type of program record to retrieve
Return	`osid.course.program.records.ProgramRecord`		the program record
Errors	NULL_ARGUMENT		`programRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.