OSID Specifications
inquiry package
Version 3.1.0
inquiry package
Version 3.1.0
| Interface | osid.inquiry.ResponseSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.inquiry.ResponseSearchSession | ||
osid.inquiry.ResponseSmartInquestSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByInquiry | ||
| Description |
Orders the results by inquiry. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInquirySearchOrder | ||
| Description |
Tests if an inquiry search order is available. | ||
| Return | boolean | true if an inquiry search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquirySearchOrder | ||
| Description |
Gets the inquiry search order. | ||
| Return | osid.inquiry.InquirySearchOrder | the inquiry search order | |
| Errors | ILLEGAL_STATE | supportsInquirySearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByResponder | ||
| Description |
Orders the results by responder resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResponderSearchOrder | ||
| Description |
Tests if a responder 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 | getResponderSearchOrder | ||
| Description |
Gets the responder resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | ILLEGAL_STATE | supportsResponderSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRespondingAgent | ||
| Description |
Orders the results by responding agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRespondingAgentSearchOrder | ||
| Description |
Tests if a responding 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 | getRespondingAgentSearchOrder | ||
| Description |
Gets the responding agent search order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | ILLEGAL_STATE | supportsRespondingAgentSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAffirmative | ||
| Description |
Orders the results by affirmative responses. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseSearchOrderRecord | ||
| Description |
Gets the response search order record corresponding to
the given response record | ||
| Parameters | osid.type.Type | responseRecordType | a response record type |
| Return | osid.inquiry.records.ResponseSearchOrderRecord | the response order record interface | |
| Errors | NULL_ARGUMENT | responseRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(responseRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |