| Interface | osid.inquiry.InquirySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByAudit | ||
| Description | 
                     Orders the results by the audit.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAuditSearchOrder | ||
| Description | 
                     Tests if an audit search order is available.  | ||
| Return | boolean |  true  if an audit search order is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditSearchOrder | ||
| Description | 
                     Gets the audit search order.  | ||
| Return | osid.inquiry.AuditSearchOrder | the audit search order | |
| Errors | ILLEGAL_STATE |  supportsAuditSearchOrder()  is  false   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByQuestion | ||
| Description | 
                     Orders the results by the question.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequired | ||
| Description | 
                     Orders the results by the required flag.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAffirmationRequired | ||
| Description | 
                     Orders the results by the affirmation required flag.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByNeedsOneResponse | ||
| Description | 
                     Orders the results by the needs one response flag.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquirySearchOrderRecord | ||
| Description | 
                     Gets the inquiry search order record corresponding to 
                    the given inquiry record   | ||
| Parameters | osid.type.Type | inquiryRecordType | an inquiry record type | 
| Return | osid.inquiry.records.InquirySearchOrderRecord | the inquiry search order record | |
| Errors | NULL_ARGUMENT |  inquiryRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(inquiryRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |