Interface | osid.rules.check.CheckSearchSession | ||
---|---|---|---|
Implements | osid.rules.check.CheckQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Checks may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCheckSearch | ||
Description |
Gets a check search. | ||
Return | osid.rules.check.CheckSearch | the check search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCheckSearchOrder | ||
Description |
Gets a check search order. The | ||
Return | osid.rules.check.CheckSearchOrder | the check search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getChecksBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.rules.check.CheckQuery | checkQuery | the check query |
osid.rules.check.CheckSearch | checkSearch | the check search | |
Return | osid.rules.check.CheckSearchResults | the check search results | |
Errors | NULL_ARGUMENT | checkQuery or checkSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | checkQuery or checkSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCheckQueryFromInspector | ||
Description |
Gets a check query from an inspector. The inspector is
available from a | ||
Parameters | osid.rules.check.CheckQueryInspector | checkQueryInspector | a check query inspector |
Return | osid.rules.check.CheckQuery | the check query | |
Errors | NULL_ARGUMENT | checkQueryInspector is null | |
UNSUPPORTED | checkQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |