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

Interface	osid.course.requisite.RequisiteRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
	`osid.course.requisite.RequisiteRequirementList`
Description	A `RequisiteRequirement` is an `OsidRule` and represents a requirement based on a `Requisite`.
Method	getAltRequisites
Description	Gets any `Requisites` that may be substituted in place of this `RequisiteRequirement`. All `Requisites` must be satisifed to be a substitute for this requisite requirement. Inactive `Requisites` are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteIds
Description	Gets the `Ids` of the `Requisites`.
Return	`osid.id.IdList`		the requisite `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getRequisites
Description	Gets the `Requisites`. If `requiresMinimumNumber()` is `false` , then all `Requisites` in this set must be completed for this requirement.
Return	`osid.course.requisite.RequisiteList`		the requisites
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `Requisites` from the set must be completed to satisfy this `RequisiteRequirement`.
Return	`boolean`		`true` if a minimum number of requisites is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `Requisites` in this `RequisiteRequirement` to complete from the set.
Return	`cardinal`		the minimum number of requisites
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 `Requisites` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum requisite count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of requisites in the set to be a valid requirement.
Return	`cardinal`		the minimum number of requisites in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the requisite has to be earned within the required duration.
Return	`boolean`		`true` if the requisite 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 requisite has to be earned. A negative duration indicates the requisite had to be earned within the specified amount of time in the past. A posiitive duration indicates the requisite must be earned within the specified amount of time in the future. A zero duration indicates the requisite 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	getRequisiteRequirementRecord
Description	Gets the requisite requirement record corresponding to the given `RequisiteRequirement` record `Type`. This method is used to retrieve an object implementing the requested record. The `requisiteRequirementRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(requisiteRequirementRecordType)` is `true`.
Parameters	`osid.type.Type`	`requisiteRequirementRecordType`	the type of requisite requirement record to retrieve
Return	`osid.course.requisite.records.RequisiteRequirementRecord`		the requisite requirement record
Errors	NULL_ARGUMENT		`requisiteRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requisiteRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.