OSID - osid.provisioning.RequestForm Service Interface Definition

Interface	osid.provisioning.RequestForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.provisioning.batch.RequestBatchForm`
Used By	`osid.provisioning.ExchangeSession`
Used By	`osid.provisioning.RequestAdminSession`
Description	This is the form for creating and updating `Requests`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `RequestAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getPoolMetadata
Description	Gets the metadata for the pool.
Return	`osid.Metadata`		metadata for the pool
Compliance	`mandatory`		This method must be implemented.
Method	setPool
Description	Sets the pool.
Parameters	`osid.id.Id`	`poolId`	the new pool
Errors	INVALID_ARGUMENT		`poolId` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearPool
Description	Removes the pool.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestedProvisionablesMetadata
Description	Gets the metadata for the requested provisionable.
Return	`osid.Metadata`		metadata for the requested provisionable
Compliance	`mandatory`		This method must be implemented.
Method	setRequestedProvisionables
Description	Sets the requested provisionables. The request will be fulfilled if one of the requested provisionables are available but not result in the provisioning of more than one of the given provisionables.
Parameters	`osid.id.IdList`	`provisionableIds`	the new requested provisionables
Errors	INVALID_ARGUMENT		a `provisionableId` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequestedProvisionables
Description	Removes the requested provisionable.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPositionMetadata
Description	Gets the metadata for the posiiton.
Return	`osid.Metadata`		metadata for the position
Compliance	`mandatory`		This method must be implemented.
Method	setPosition
Description	Sets the position. A new position inserts at the given place in the queue for queues that support manual positioning.
Parameters	`integer`	`position`	the new position
Errors	INVALID_ARGUMENT		`position` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearPosition
Description	Removes the position.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestFormRecord
Description	Gets the `RequestFormRecord` corresponding to the given request record `Type`.
Parameters	`osid.type.Type`	`requestRecordType`	a request record type
Return	`osid.provisioning.records.RequestFormRecord`		the request form record
Errors	NULL_ARGUMENT		`requestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requestRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.