Interface | osid.sequencing.ChainSearchSession | ||
---|---|---|---|
Implements | osid.sequencing.ChainQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Chains may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getChainSearch | ||
Description |
Gets a chain search. | ||
Return | osid.sequencing.ChainSearch | the chain search | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainSearchOrder | ||
Description |
Gets a chain search order. The | ||
Return | osid.sequencing.ChainSearchOrder | the chain search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.sequencing.ChainQuery | chainQuery | the chain query |
osid.sequencing.ChainSearch | chainSearch | the chain search | |
Return | osid.sequencing.ChainSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | chainQuery or chainSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | chainQuery or chainSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainQueryFromInspector | ||
Description |
Gets a chain query from an inspector. The inspector is
available from a | ||
Parameters | osid.sequencing.ChainQueryInspector | chainQueryInspector | a chain query inspector |
Return | osid.sequencing.ChainQuery | the chain query | |
Errors | NULL_ARGUMENT | chainQueryInspector is null | |
UNSUPPORTED | chainQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |