| Interface | osid.provisioning.RequestTransactionSearchOrder | ||
|---|---|---|---|
| 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 | orderBySubmitDate | ||
| Description | 
                     Orders the results by the submit date.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySubmitter | ||
| Description | 
                     Orders the results by the submitter.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSubmitterSearchOrder | ||
| 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 | getSubmitterSearchOrder | ||
| Description | 
                     Gets the resource search order.  | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | ILLEGAL_STATE |  supportsSubmitterSearchOrder()  is  false   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySubmittingAgent | ||
| Description | 
                     Orders the results by submitting agent.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSubmittingAgentSearchOrder | ||
| 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 | getSubmittingAgentSearchOrder | ||
| Description | 
                     Gets the agent search order.  | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | ILLEGAL_STATE |  supportsSubmittingAgentSearchOrder()  is  false   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestTransactionSearchOrderRecord | ||
| Description | 
                     Gets the request transaction search order record 
                    corresponding to the given request record   | ||
| Parameters | osid.type.Type | requestTransactionRecordType | a request transaction record type | 
| Return | osid.provisioning.records.RequestTransactionSearchOrderRecord | the request transaction search order record | |
| Errors | NULL_ARGUMENT |  requestTransactionRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(requestTransactionRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |