Interface | osid.rules.check.CheckSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRuleSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByTimeCheckStartDate | ||
Description |
Orders the results by the time check start date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByTimeCheckEndDate | ||
Description |
Orders the results by the time end check date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByTimeCheckEvent | ||
Description |
Orders the results by the time check event. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTimeCheckEventSearchOrder | ||
Description |
Tests if an event search order is available. | ||
Return | boolean | true if an event search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimeCheckEventSearchOrder | ||
Description |
Gets the event search order. | ||
Return | osid.calendaring.EventSearchOrder | the event search order | |
Errors | ILLEGAL_STATE | supportsTimeCheckEventSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByTimeCheckCyclicEvent | ||
Description |
Orders the results by cyclic event. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTimeCheckCyclicEventSearchOrder | ||
Description |
Tests if a cyclic event search order is available. | ||
Return | boolean | true if a cyclic event search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimeCheckCyclicEventSearchOrder | ||
Description |
Gets the cyclic event search order. | ||
Return | osid.calendaring.cycle.CyclicEventSearchOrder | the cyclic event search order | |
Errors | ILLEGAL_STATE | supportsTimeCheckCyclicEventSearchOrder() is false
| |
Compliance | mandatory | This method must be implemented. | |
Method | orderByHoldCheckBlock | ||
Description |
Orders the results by block. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldCheckBlockSearchOrder | ||
Description |
Tests if a block search order is available. | ||
Return | boolean | true if a block search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldCheckBlockSearchOrder | ||
Description |
Gets the block search order. | ||
Return | osid.hold.BlockSearchOrder | the block search order | |
Errors | ILLEGAL_STATE | supportsHoldCheckBlockSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByInquiryCheckAudit | ||
Description |
Orders the results by audit. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInquiryCheckAuditSearchOrder | ||
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 | getInquiryCheckAuditSearchOrder | ||
Description |
Gets the audit search order. | ||
Return | osid.inquiry.AuditSearchOrder | the audit search order | |
Errors | ILLEGAL_STATE | supportsInquiryCheckAuditSearchOrder() is false
| |
Compliance | mandatory | This method must be implemented. | |
Method | orderByProcessCheckAgenda | ||
Description |
Orders the results by agenda. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcessCheckAgendaSearchOrder | ||
Description |
Tests if an agenda search order is available. | ||
Return | boolean | true if an agenda search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessCheckAgendaSearchOrder | ||
Description |
Gets the agenda search order. | ||
Return | osid.rules.check.AgendaSearchOrder | the agenda search order | |
Errors | ILLEGAL_STATE | supportsProcessCheckAgendaSearchOrder() is false
| |
Compliance | mandatory | This method must be implemented. | |
Method | getCheckSearchOrderRecord | ||
Description |
Gets the check search order record corresponding to the
given check record | ||
Parameters | osid.type.Type | checkRecordType | a check record type |
Return | osid.rules.check.records.CheckSearchOrderRecord | the check search order record | |
Errors | NULL_ARGUMENT | checkRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(checkRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |