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

A AwardRequirement is an OsidRule and represents a requirement based on an Award.

MethodgetAltRequisites
Description

Gets any Requisites that may be substituted in place of this AwardRequirement. All Requisites must be satisifed to be a substitute for this award 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.
MethodgetAwardId
Description

Gets the Id of the Award.

Returnosid.id.Idthe award Id
CompliancemandatoryThis method must be implemented.
MethodgetAward
Description

Gets the Award.

Returnosid.recognition.Awardthe award
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasTimeframe
Description

Tests if the award must have been earned within the required duration.

Returnboolean true if the award has to be earned within a required time, false if it could have been completed at any time in the past
CompliancemandatoryThis method must be implemented.
MethodgetTimeframe
Description

Gets the timeframe in which the award has to be earned. A negative duration indicates the award had to be completed within the specified amount of time in the past. A posiitive duration indicates the award must be completed within the specified amount of time in the future. A zero duration indicates the award must be completed in the current term.

Returnosid.calendaring.Durationthe time frame
ErrorsILLEGAL_STATE hasTimeframe() is false
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementRecord
Description

Gets the award requirement record corresponding to the given AwardRequirement record Type. This method is used to retrieve an object implementing the requested record. The awardRequirementRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(awardRequirementRecordType) is true .

Parametersosid.type.TypeawardRequirementRecordTypethe type of award requirement record to retrieve
Returnosid.course.requisite.records.AwardRequirementRecordthe award requirement record
ErrorsNULL_ARGUMENT awardRequirementRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardRequirementRecordType) is false
CompliancemandatoryThis method must be implemented.