Interface | osid.process.StateSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getStates | ||
Description |
Gets the state list resulting from a search. | ||
Return | osid.process.StateList | the state list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStateQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.process.StateQueryInspector | the state query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStateSearchResultsRecord | ||
Description |
Gets the state search results record corresponding to
the given state search record | ||
Parameters | osid.type.Type | stateSearchRecordType | a state search record type |
Return | osid.process.records.StateSearchResultsRecord | the state search results record | |
Errors | NULL_ARGUMENT | stateSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(stateSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |