OSID Specifications
provisioning rules package
Version 3.1.0
provisioning rules package
Version 3.1.0
| Interface | osid.provisioning.rules.BrokerProcessorSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidProcessorSearchOrder | ||
| Used By | osid.provisioning.rules.BrokerProcessorSearchSession | ||
osid.provisioning.rules.BrokerProcessorSmartDistributorSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByLeasing | ||
| Description |
Orders the results by the leasing flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFixedLeaseDuration | ||
| Description |
Orders the results by the fixed lease duration. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMustReturnProvisions | ||
| Description |
Orders the results by the must return provisions flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAllowsProvisionExchange | ||
| Description |
Orders the results by the allows provision exchange flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAllowsCompoundRequests | ||
| Description |
Orders the results by the allows compound requests flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerProcessorSearchOrderRecord | ||
| Description |
Gets the broker processor search order record
corresponding to the given broker processor record
| ||
| Parameters | osid.type.Type | brokerProcessorRecordType | a broker processor record type |
| Return | osid.provisioning.rules.records.BrokerProcessorSearchOrderRecord | the broker processor search order 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. | |