OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetChains
Description

Gets the chain list resulting from a search.

Returnosid.sequencing.ChainListthe chain list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetChainQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.sequencing.ChainQueryInspectorthe chain query inspector
CompliancemandatoryThis method must be implemented.
MethodgetChainSearchResultsRecord
Description

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

Parametersosid.type.TypechainSearchRecordTypea chain search record type
Returnosid.sequencing.records.ChainSearchResultsRecordthe chain search results record
ErrorsNULL_ARGUMENT chainSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(chainSearchRecordType) is false
CompliancemandatoryThis method must be implemented.