Interface | osid.provisioning.ProvisionSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByBroker | ||
Description |
Orders the results by the 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 | orderByProvisionable | ||
Description |
Orders the results by the provisionable. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableSearchOrder | ||
Description |
Tests if a provisionable search order is available. | ||
Return | boolean | true if a provisionable search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableSearchOrder | ||
Description |
Gets the provisionable search order. | ||
Return | osid.provisioning.ProvisionableSearchOrder | the provisionable search order | |
Errors | ILLEGAL_STATE | supportsProvisionableSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByRecipient | ||
Description |
Orders the results by the recipient. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipientSearchOrder | ||
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 | getRecipientSearchOrder | ||
Description |
Gets the resource search order. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | ILLEGAL_STATE | supportsRecipientSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByRequest | ||
Description |
Orders the results by the request. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestSearchOrder | ||
Description |
Tests if a request search order is available. | ||
Return | boolean | true if a request search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestSearchOrder | ||
Description |
Gets the request search order. | ||
Return | osid.provisioning.RequestSearchOrder | the request search order | |
Errors | ILLEGAL_STATE | supportsRequestSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByProvisionDate | ||
Description |
Orders the results by the provision date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByLeased | ||
Description |
Orders the results by the leased flag. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByMustReturn | ||
Description |
Orders the results by the must return flag. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDueDate | ||
Description |
Orders the results by the due date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCost | ||
Description |
Orders the results by the cost. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByRate | ||
Description |
Orders the results by the rate amount and period. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByProvisionReturn | ||
Description |
Orders the results by returned. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionReturnSearchOrder | ||
Description |
Tests if a provision return search order is available. | ||
Return | boolean | true if a provision return search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionReturnSearchOrder | ||
Description |
Gets the provision return search order. | ||
Return | osid.provisioning.ProvisionReturnSearchOrder | the provision return search order | |
Errors | ILLEGAL_STATE | supportsProvisionReturnSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionSearchOrderRecord | ||
Description |
Gets the provision search order record corresponding to
the given provision record | ||
Parameters | osid.type.Type | provisionRecordType | a provision record type |
Return | osid.provisioning.records.ProvisionSearchOrderRecord | the provision search order record | |
Errors | NULL_ARGUMENT | provisionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(provisionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |