OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.CredentialRequirement
Implementsosid.OsidRule
osid.Aggregateable
Description

A CredentialRequirement is an OsidRule and represents a requirement based on a Credential.

MethodgetAltRequisites
Description

Gets any Requisites that may be substituted in place of this CredentialRequirement. All Requisites must be satisifed to be a substitute for this credential requirement. Inactive Requisites are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.

Returnosid.course.requisite.Requisite[]the alternate requisites
CompliancemandatoryThis method must be implemented.
MethodgetCredentialId
Description

Gets the Id of the Credential.

Returnosid.id.Idthe credential Id
CompliancemandatoryThis method must be implemented.
MethodgetCredential
Description

Gets the Credential.

Returnosid.course.program.Credentialthe credential
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasTimeframe
Description

Tests if the credential has to be earned within the required duration.

Returnboolean true if the credential must be earned within a required time, false if it could have been earned at any time in the past
CompliancemandatoryThis method must be implemented.
MethodgetTimeframe
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.

Returnosid.calendaring.Durationthe time frame
ErrorsILLEGAL_STATE hasTimeframe() is false
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementRecord
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 .

Parametersosid.type.TypecredentialRequirementRecordTypethe type of credential requirement record to retrieve
Returnosid.course.requisite.records.CredentialRequirementRecordthe credential requirement record
ErrorsNULL_ARGUMENT credentialRequirementRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialRequirementRecordType) is false
CompliancemandatoryThis method must be implemented.