Interface | osid.provisioning.ProvisionableSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
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 | orderByResource | ||
Description |
Orders the results by resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceSearchOrder | ||
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 | getResourceSearchOrder | ||
Description |
Gets the resource search order. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | ILLEGAL_STATE | supportsResourceSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByUse | ||
Description |
Orders the results by use. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableSearchOrderRecord | ||
Description |
Gets the provisionable search order record
corresponding to the given provisionable record | ||
Parameters | osid.type.Type | provisionableRecordType | a provisionable record type |
Return | osid.provisioning.records.ProvisionableSearchOrderRecord | the provisionable order record interface | |
Errors | NULL_ARGUMENT | provisionableRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(provisionableRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |