Interface | osid.rules.check.CheckSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getChecks | ||
Description |
Gets the check list resulting from a search. | ||
Return | osid.rules.check.CheckList | the check list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCheckQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.rules.check.CheckQueryInspector | the check query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCheckSearchResultsRecord | ||
Description |
Gets the check search results record corresponding to
the given check search record | ||
Parameters | osid.type.Type | checkSearchRecordType | a check search record type |
Return | osid.rules.check.records.CheckSearchResultsRecord | the check search results record | |
Errors | NULL_ARGUMENT | checkSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(checkSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |