Interface | osid.process.StateSearchSession | ||
---|---|---|---|
Implements | osid.process.StateQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
States may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getStateSearch | ||
Description |
Gets a state search. | ||
Return | osid.process.StateSearch | the state search | |
Compliance | mandatory | This method must be implemented. | |
Method | getStateSearchOrder | ||
Description |
Gets a state search order. The | ||
Return | osid.process.StateSearchOrder | the state search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getStatesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.process.StateQuery | stateQuery | the state query |
osid.process.StateSearch | stateSearch | the state search | |
Return | osid.process.StateSearchResults | the state search results | |
Errors | NULL_ARGUMENT | stateQuery or stateSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stateQuery or stateSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStateQueryFromInspector | ||
Description |
Gets a state query from an inspector. The inspector is
available from a | ||
Parameters | osid.process.StateQueryInspector | stateQueryInspector | a state inspector |
Return | osid.process.StateQuery | the state query | |
Errors | NULL_ARGUMENT | stateQueryInspector is null | |
UNSUPPORTED | stateQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |