OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainSearchSession
Implementsosid.sequencing.ChainQuerySession
Description

This session provides methods for searching among Chain objects. The search query is constructed using the ChainQuery.

getChainsByQuery() is the basic search method and returns a list of Chains. A more advanced search may be performed with getChainsBySearch(). It accepts an ChainSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getChainsBySearch() returns an ChainSearchResults that can be used to access the resulting ChainList or be used to perform a search within the result set through ChainSearch.

This session defines views that offer differing behaviors for searching.

  • federated antimatroid view: searches include chains in antimatroids of which this antimatroid is an ancestor in the antimatroid hierarchy
  • isolated antimatroid view: searches are restricted to chains in this antimatroid

Chains may have a query record indicated by their respective record types. The query record is accessed via the ChainQuery.

MethodgetChainSearch
Description

Gets a chain search.

Returnosid.sequencing.ChainSearchthe chain search
CompliancemandatoryThis method must be implemented.
MethodgetChainSearchOrder
Description

Gets a chain search order. The ChainSearchOrder is supplied to a ChainSearch to specify the ordering of results.

Returnosid.sequencing.ChainSearchOrderthe chain search order
CompliancemandatoryThis method must be implemented.
MethodgetChainsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.sequencing.ChainQuerychainQuerythe chain query
osid.sequencing.ChainSearchchainSearchthe chain search
Returnosid.sequencing.ChainSearchResultsthe returned search results
ErrorsNULL_ARGUMENT chainQuery or chainSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED chainQuery or chainSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetChainQueryFromInspector
Description

Gets a chain query from an inspector. The inspector is available from a ChainSearchResults.

Parametersosid.sequencing.ChainQueryInspectorchainQueryInspectora chain query inspector
Returnosid.sequencing.ChainQuerythe chain query
ErrorsNULL_ARGUMENT chainQueryInspector is null
UNSUPPORTED chainQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.