OSID - osid.provisioning.PoolForm Service Interface Definition

Interface	osid.provisioning.PoolForm
Implements	`osid.OsidGovernatorForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.provisioning.batch.PoolBatchForm`
Used By	`osid.provisioning.PoolAdminSession`
Description	This is the form for creating and updating `Pools` .Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PoolAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getSuppliersMetadata
Description	Gets the metadata for the suppliers.
Return	`osid.Metadata`		metadata for the suppliers
Compliance	`mandatory`		This method must be implemented.
Method	setSuppliers
Description	Sets the suppliers.
Parameters	`osid.id.IdList`	`supplierIds`	the supplier `Ids`
Errors	INVALID_ARGUMENT		`supplierIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`supplierIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSuppliers
Description	Removes the suppliers.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolFormRecord
Description	Gets the `PoolFormRecord` corresponding to the given pool record `Type` .
Parameters	`osid.type.Type`	`poolRecordType`	a pool record type
Return	`osid.provisioning.records.PoolFormRecord`		the pool form record
Errors	NULL_ARGUMENT		`poolRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.