OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.AwardRequirementForm
Implementsosid.OsidRuleForm
osid.OsidAggregateableForm
Description

This is the form for creating and updating AwardRequirements. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RequisiteAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetTimeframeMetadata
Description

Gets the metadata for the timeframe.

Returnosid.Metadatametadata for the timeframe
CompliancemandatoryThis method must be implemented.
MethodsetTimeframe
Description

Sets the timeframe.

Parametersosid.calendaring.Durationdurationthe new duration
ErrorsINVALID_ARGUMENT duration is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT duration is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeframe
Description

Clears the timeframe.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAwardlRequirementFormRecord
Description

Gets the AwardRequirementFormRecord corresponding to the given awardl requirement record Type.

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