OSID - osid.provisioning.RequestSearchOrder Service Interface Definition

Interface	osid.provisioning.RequestSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.provisioning.ProvisionSearchOrder`
	`osid.provisioning.RequestSearchSession`
	`osid.provisioning.RequestSmartDistributorSession`
Description	An interface for specifying the ordering of search results.
Method	orderByRequestTransaction
Description	Orders the results by the request transaction.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestTransactionSearchOrder
Description	Tests if a request transaction search order is available.
Return	`boolean`		`true` if a request transaction search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionSearchOrder
Description	Gets the request transaction search order.
Return	`osid.provisioning.RequestTransactionSearchOrder`		the request transaction search order
Errors	ILLEGAL_STATE		`supportsRequestTransactionSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByQueue
Description	Orders the results by queue.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueSearchOrder
Description	Tests if a queue search order is available.
Return	`boolean`		`true` if a queue search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueSearchOrder
Description	Gets the queue search order.
Return	`osid.provisioning.QueueSearchOrder`		the queue search order
Errors	ILLEGAL_STATE		`supportsQueueSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRequestDate
Description	Orders the results by request date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRequester
Description	Orders the results by the requester.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequesterSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequesterSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsRequesterSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRequestingAgent
Description	Orders the results by requesting agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestingAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestingAgentSearchOrder
Description	Gets the resource search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsRequestingAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByPool
Description	Orders the results by pool.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPoolSearchOrder
Description	Tests if a pool search order is available.
Return	`boolean`		`true` if a pool search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPoolSearchOrder
Description	Gets the pool search order.
Return	`osid.provisioning.PoolSearchOrder`		the pool search order
Errors	ILLEGAL_STATE		`supportsPoolSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExchangeProvision
Description	Orders the results by exchange resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsExchangeProvisionSearchOrder
Description	Tests if an exchange provision search order is available.
Return	`boolean`		`true` if a provision search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExchangeProvisionSearchOrder
Description	Gets the exchange provision search order.
Return	`osid.provisioning.ProvisionSearchOrder`		the provision search order
Errors	ILLEGAL_STATE		`supportsExchangeProvisionSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByOriginProvision
Description	Orders the results by origin provision.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsOriginProvisionSearchOrder
Description	Tests if an origin provision search order is available.
Return	`boolean`		`true` if a provision search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOriginProvisionSearchOrder
Description	Gets the origin provision search order.
Return	`osid.provisioning.ProvisionSearchOrder`		the provision search order
Errors	ILLEGAL_STATE		`supportsOriginProvisionSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByPosition
Description	Orders the results by position.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEWA
Description	Orders the results by the estimated waiting time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestSearchOrderRecord
Description	Gets the request search order record corresponding to the given request record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`requestRecordType`	a request record type
Return	`osid.provisioning.records.RequestSearchOrderRecord`		the request search order record
Errors	NULL_ARGUMENT		`requestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requestRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.