OSID Logo
OSID Specifications
sequencing package
Version 3.1.0
Interfaceosid.sequencing.ChainSearch
Implementsosid.OsidSearch
Used Byosid.sequencing.ChainSearchSession
Description

The search interface for governing chain searches.

MethodsearchAmongChains
Description

Execute this search among the given list of chains.

Parametersosid.id.IdListchainIds list of chains
ErrorsNULL_ARGUMENT chainIds is null
Compliancemandatory This method must be implemented.
MethodorderChainResults
Description

Specify an ordering to the search results.

Parametersosid.sequencing.ChainSearchOrderchainSearchOrder chain search order
ErrorsNULL_ARGUMENT chainSearchOrder is null
UNSUPPORTED chainSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetChainSearchRecord
Description

Gets the chain search record corresponding to the given chain search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypechainSearchRecordType a chain search record type
Returnosid.sequencing.records.ChainSearchRecord the chain search interface
ErrorsNULL_ARGUMENT chainSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(chainSearchRecordType) is false
Compliancemandatory This method must be implemented.