OSID - osid.provisioning.PoolSearchOrder Service Interface Definition

Interface	osid.provisioning.PoolSearchOrder
Implements	`osid.OsidGovernatorSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.provisioning.PoolSearchSession`
	`osid.provisioning.PoolSmartDistributorSession`
	`osid.provisioning.ProvisionableSearchOrder`
	`osid.provisioning.RequestSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByBroker
Description	Orders the results by broker.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsBrokerSearchOrder
Description	Tests if a broker search order is available.
Return	`boolean`		`true` if a broker search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerSearchOrder
Description	Gets the broker search order.
Return	`osid.provisioning.BrokerSearchOrder`		the broker search order
Errors	ILLEGAL_STATE		`supportsBrokerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySize
Description	Orders the results by pool size.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolSearchOrderRecord
Description	Gets the pool search order record corresponding to the given pool record `Type` . Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`poolRecordType`	a pool record type
Return	`osid.provisioning.records.PoolSearchOrderRecord`		the pool search order 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.