OSID Specifications
provisioning package
Version 3.1.0
provisioning package
Version 3.1.0
| Interface | osid.provisioning.QueueSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.provisioning.QueueSearchSession | ||
osid.provisioning.QueueSmartDistributorSession | |||
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 queue size. | ||
| 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 estimated waiting time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCanSpecifyProvisionable | ||
| Description |
Orders the results by the can request provisionables flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueSearchOrderRecord | ||
| Description |
Gets the queue search order record corresponding to
the given queue record | ||
| Parameters | osid.type.Type | queueRecordType | a queue record type |
| Return | osid.provisioning.records.QueueSearchOrderRecord | the queue search order record | |
| Errors | NULL_ARGUMENT | queueRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(queueRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |