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

Interface	osid.provisioning.rules.BrokerProcessor
Implements	`osid.OsidProcessor`
Used By	`osid.provisioning.rules.BrokerProcessorAdminSession`
	`osid.provisioning.rules.BrokerProcessorList`
	`osid.provisioning.rules.BrokerProcessorLookupSession`
Description	A `BrokerProcessor` manages the operation of a `Broker`.
Method	isLeasing
Description	Tests if this broker provides leases. A lease is a temporary provision that expires or must be returned.
Return	`boolean`		true if this is a leasing broker, false if the brokered provisions are permanent
Compliance	`mandatory`		This method must be implemented.
Method	hasFixedLeaseDuration
Description	Tests if leases from this broker have fixed durations.
Return	`boolean`		`true` if leases have fixed durations, `false` otherwise
Errors	ILLEGAL_STATE		`isLeasing()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getFixedLeaseDuration
Description	Gets the fixed lease duration.
Return	`osid.calendaring.Duration`		the fixed lease duration
Errors	ILLEGAL_STATE		`hasFixedLeaseDuration()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	mustReturnProvisions
Description	Tests if provisions from this broker must be returned.
Return	`boolean`		`true` if this broker requires provision return, `false` otherwise
Errors	ILLEGAL_STATE		`isLeasing()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	allowsProvisionExchange
Description	Tests if this broker allows exchanging of provisions.
Return	`boolean`		`true` if provision exchange is permitted, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	allowsCompoundRequests
Description	Tests if this broker allows compound requests using `RequestTransactions`.
Return	`boolean`		`true` if compound requests are permitted, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorRecord
Description	Gets the broker processor record corresponding to the given `BrokerProcessor` record `Type`. This method ie used to retrieve an object implementing the requested record. The `brokerProcessorRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(brokerProcessorRecordType)` is `true`.
Parameters	`osid.type.Type`	`brokerProcessorRecordType`	the type of broker processor record to retrieve
Return	`osid.provisioning.rules.records.BrokerProcessorRecord`		the broker processor 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.