OSID - osid.provisioning.rules.PoolProcessorForm Service Interface Definition

Interface	osid.provisioning.rules.PoolProcessorForm
Implements	`osid.OsidProcessorForm`
Used By	`osid.provisioning.rules.PoolProcessorAdminSession`
Description	This is the form for creating and updating `PoolProcessors` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PoolProcessorAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getAllocatesByLeastUseMetadata
Description	Gets the metadata for the allocates by least use flag.
Return	`osid.Metadata`		metadata for the allocation flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllocatesByLeastUse
Description	Sets allocates by least use flag. Seeting this allocation rule may disable the other allocation rules.
Parameters	`boolean`	`allocateByLeastUse`	`true` to allocate by least use, `false` otherwise
Errors	INVALID_ARGUMENT		`allocateByLeastUse` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocateByLeastUse
Description	Removes the allocate by least use flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByMostUseMetadata
Description	Gets the metadata for the allocates by most use flag.
Return	`osid.Metadata`		metadata for the allocation flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllocatesByMostUse
Description	Sets allocates by most use flag. Seeting this allocation rule may disable the other allocation rules.
Parameters	`boolean`	`allocateByMostUse`	`true` to allocate by most use, `false` otherwise
Errors	INVALID_ARGUMENT		`allocateByMostUse` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocateByMostUse
Description	Removes the allocate by most use flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByLeastCostMetadata
Description	Gets the metadata for the allocates by least cost flag.
Return	`osid.Metadata`		metadata for the allocation flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllocatesByLeastCost
Description	Sets allocates by least cost flag. Seeting this allocation rule may disable the other allocation rules.
Parameters	`boolean`	`allocateByLeastCost`	`true` to allocate by least cost, `false` otherwise
Errors	INVALID_ARGUMENT		`allocateByLeastCost` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocateByLeastCost
Description	Removes the allocate by least cost flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllocatesByMostCostMetadata
Description	Gets the metadata for the allocates by most cost flag.
Return	`osid.Metadata`		metadata for the allocation flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllocatesByMostCost
Description	Sets allocates by most cost flag. Seeting this allocation rule may disable the other allocation rules.
Parameters	`boolean`	`allocateByMostCost`	`true` to allocate by most cost, `false` otherwise
Errors	INVALID_ARGUMENT		`allocateByMostCost` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocateByMostCost
Description	Removes the allocate by most cost flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorFormRecord
Description	Gets the `PoolProcessorFormRecord` corresponding to the given pool processor record `Type` .
Parameters	`osid.type.Type`	`poolProcessorRecordType`	a pool processor record type
Return	`osid.provisioning.rules.records.PoolProcessorFormRecord`		the pool processor form record
Errors	NULL_ARGUMENT		`poolProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.