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

Interface	osid.course.requisite.AwardRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
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. Like all `OsidForms`, `AwardRequirementForm` is stateful and must not be accessed by multiple processing threads.
Method	getAwardsMetadata
Description	Gets the metadata for the awards.
Return	`osid.Metadata`		metadata for the awards
Compliance	`mandatory`		This method must be implemented.
Method	setAwards
Description	Sets the awards.
Parameters	`osid.id.Id[]`	`awardIds`	the new awards
Errors	INVALID_ARGUMENT		`awardIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`awardIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAwards
Description	Removes the awards.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumberMetadata
Description	Gets the metadata for the minimum number of awards.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of awards to complete from the set.
Parameters	`cardinal`	`number`	the new minimum number
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumNumber
Description	Clears the minimum number of awards.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumberMetadata
Description	Gets the metadata for the target number of awards in the set.
Return	`osid.Metadata`		metadata for the target set number
Compliance	`mandatory`		This method must be implemented.
Method	setTargetSetNumber
Description	Sets the target number of awards in the set.
Parameters	`cardinal`	`number`	the new target set number
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetSetNumber
Description	Clears the target set number.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframeMetadata
Description	Gets the metadata for the timeframe.
Return	`osid.Metadata`		metadata for the timeframe
Compliance	`mandatory`		This method must be implemented.
Method	setTimeframe
Description	Sets the timeframe.
Parameters	`osid.calendaring.Duration`	`duration`	the new duration
Errors	INVALID_ARGUMENT		`duration` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`duration` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeframe
Description	Clears the timeframe.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardlRequirementFormRecord
Description	Gets the `AwardRequirementFormRecord` corresponding to the given awardl requirement record `Type`.
Parameters	`osid.type.Type`	`awardRequirementRecordType`	an award requirement record type
Return	`osid.course.requisite.records.AwardRequirementFormRecord`		the award requirement form 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.