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

Interface	osid.course.requisite.RequisiteRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
Description	This is the form for creating and updating `RequisiteRequirements`. 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.
Method	getRequisitesMetadata
Description	Gets the metadata for the requisites.
Return	`osid.Metadata`		metadata for the requisites
Compliance	`mandatory`		This method must be implemented.
Method	setRequisites
Description	Sets the requisites.
Parameters	`osid.id.Id[]`	`requisiteIds`	the new requisites
Errors	INVALID_ARGUMENT		`requisiteIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`requisiteIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequisites
Description	Removes the requisites.
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 requisites.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of requisites 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 requisites.
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 requisites 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 requisites 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	getRequisiteRequirementFormRecord
Description	Gets the `RequisiteRequirementFormRecord` corresponding to the given requisite requirement record `Type`.
Parameters	`osid.type.Type`	`requisiteRequirementRecordType`	a requisite requirement record type
Return	`osid.course.requisite.records.RequisiteRequirementFormRecord`		the requisite requirement form 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.