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

Interface	osid.provisioning.rules.BrokerProcessorForm
Implements	`osid.OsidProcessorForm`
Used By	`osid.provisioning.rules.BrokerProcessorAdminSession`
Description	This is the form for creating and updating `BrokerProcessors` . Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `BrokerProcessorAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getLeasingMetadata
Description	Gets the metadata for the leasing flag.
Return	`osid.Metadata`		metadata for the leasing flag
Compliance	`mandatory`		This method must be implemented.
Method	setLeasing
Description	Sets the leasing flag.
Parameters	`boolean`	`leasing`	the new leasing flag
Errors	INVALID_ARGUMENT		`leasing` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearLeasing
Description	Removes the fixed lease flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFixedLeaseDurationMetadata
Description	Gets the metadata for the fixed lease duration.
Return	`osid.Metadata`		metadata for the fixed lease duration
Compliance	`mandatory`		This method must be implemented.
Method	setFixedLeaseDuration
Description	Sets the fixed lease duration.
Parameters	`boolean`	`duration`	the new fixed lease 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	clearFixedLeaseDuration
Description	Removes the fixed lease duration.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMustReturnProvisionsMetadata
Description	Gets the metadata for the must return provisions flag.
Return	`osid.Metadata`		metadata for the must return flag
Compliance	`mandatory`		This method must be implemented.
Method	setMustReturnProvisions
Description	Sets the must return provisions flag.
Parameters	`boolean`	`mustReturn`	the new must return provisions flag
Errors	INVALID_ARGUMENT		`mustReturn` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMustReturnProvisions
Description	Removes the must return provisions flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllowsProvisionExchangeMetadata
Description	Gets the metadata for the allows provision exchange flag.
Return	`osid.Metadata`		metadata for th eallows provision exchange flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllowsProvisionExchange
Description	Sets the allows provision exchange flag.
Parameters	`boolean`	`allowsExchange`	the new allows provision exchange flag
Errors	INVALID_ARGUMENT		`allowsExchange` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllowsProvisionExchange
Description	Removes the allows provision exchange flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllowsCompoundRequestsMetadata
Description	Gets the metadata for the allows provision exchange flag.
Return	`osid.Metadata`		metadata for th eallows provision exchange flag
Compliance	`mandatory`		This method must be implemented.
Method	setAllowsCompoundRequests
Description	Sets the allows compound requests flag.
Parameters	`boolean`	`allowsCompound`	the new allows compound requests flag
Errors	INVALID_ARGUMENT		`allowsExchange` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAllowsCompoundRequests
Description	Removes the allows compound requests flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorFormRecord
Description	Gets the `BrokerProcessorFormRecord` corresponding to the given broker processor record `Type` .
Parameters	`osid.type.Type`	`brokerProcessorRecordType`	a broker processor record type
Return	`osid.provisioning.rules.records.BrokerProcessorFormRecord`		the broker processor form record
Errors	NULL_ARGUMENT		`brokerProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(brokerProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.