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

Interface	osid.course.requisite.AwardRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.AwardRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `AwardRequirement` is an `OsidRule` and represents a requirement based on a set of `Awards`. Like all `OsidObjects`, `AwardRequirement` 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 `AwardRequirement` . All `Requisites` must be satisifed to be a substitute for this award 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	getAwardIds
Description	Gets the `Ids` of the `Awards`.
Return	`osid.id.IdList`		the award `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getAwards
Description	Gets the `Awards`. If `requiresMinimumNumber()` is `false` , then all `Awards` in this set must be completed for this requirement.
Return	`osid.recognition.AwardList`		the awards
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `Awards` from the set must be completed to satisfy this `AwardRequirement`.
Return	`boolean`		`true` if a minimum number of awards is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `Awards` in this `AwardRequirement` to complete from the set.
Return	`cardinal`		the minimum number of awards
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 `Awards` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum award count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of awards in the set to be a valid requirement.
Return	`cardinal`		the minimum number of awards in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the award must have been earned within the required duration.
Return	`boolean`		`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
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframe
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.
Return	`osid.calendaring.Duration`		the time frame
Errors	ILLEGAL_STATE		`hasTimeframe()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardRequirementRecord
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`.
Parameters	`osid.type.Type`	`awardRequirementRecordType`	the type of award requirement record to retrieve
Return	`osid.course.requisite.records.AwardRequirementRecord`		the award requirement record
Errors	NULL_ARGUMENT		`awardRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(awardRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.