OSID - osid.course.requisite.CredentialRequirement Service Interface Definition

Interface	osid.course.requisite.CredentialRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.CredentialRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `CredentialRequirement` is an `OsidRule` and represents a requirement based on a set of `Credentials`. Like all `OsidObjects`, `CredentialRequirement` is managed by its `OsidSessions` and may not be accessed by concurrent processing threads.
Method	getAltRequisites
Description	Gets any `Requisites` that may be substituted in place of this `CredentialRequirement`. One or more `Requisites` must be satisifed to be a substitute for this credential requirement. Inactive `Requisites` are not evaluated but if no active requisite exists, then this term is ignored.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialIds
Description	Gets the `Ids` of the `Credentials`.
Return	`osid.id.IdList`		the credential `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentials
Description	Gets the `Credentials`. If `requiresMinimumNumber()` is `false` , then all `Credentials` in this set must be completed for this requirement.
Return	`osid.course.program.CredentialList`		the credentials
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `Credentials` from the set must be completed to satisfy this `CredentialRequirement`.
Return	`boolean`		`true` if a minimum number of credentials is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `Credentials` in this `CredentialRequirement` to complete from the set.
Return	`cardinal`		the minimum number of credentials
Errors	ILLEGAL_STATE		`requiresMinimumNumber()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTargetNumberForSet
Description	Tests if the set should contain a minimum number of `Credentials` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum credential count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of credentials in the set to be a valid requirement.
Return	`cardinal`		the minimum number of credentials in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the credential has to be earned within the required duration.
Return	`boolean`		`true` if the credential must be earned within a required time, `false` if it could have been earned at any time in the past
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframe
Description	Gets the timeframe in which the credential has to be earned. A negative duration indicates the credential had to be earned within the specified amount of time in the past. A posiitive duration indicates the credential must be earned within the specified amount of time in the future. A zero duration indicates the credential must be earned in the current term.
Return	`osid.calendaring.Duration`		the time frame
Errors	ILLEGAL_STATE		`hasTimeframe()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialRequirementRecord
Description	Gets the credential requirement record corresponding to the given `CredentialRequirement` record `Type`. This method is used to retrieve an object implementing the requested record. The `credentialRequirementRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(credentialRequirementRecordType)` is `true`.
Parameters	`osid.type.Type`	`credentialRequirementRecordType`	the type of credential requirement record to retrieve
Return	`osid.course.requisite.records.CredentialRequirementRecord`		the credential requirement record
Errors	NULL_ARGUMENT		`credentialRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(credentialRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.