Interface | osid.control.SystemSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSystems | ||
Description |
Gets the system list resulting from a search. | ||
Return | osid.control.SystemList | the system list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.SystemQueryInspector | the system query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemSearchResultsRecord | ||
Description |
Gets the system search results record corresponding to
the given system search record | ||
Parameters | osid.type.Type | systemSearchRecordType | a system search record type |
Return | osid.control.records.SystemSearchResultsRecord | the system search results record | |
Errors | NULL_ARGUMENT | systemSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(systemSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |