OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.CompositionSearchResults
Implementsosid.OsidSearchResults
Used Byosid.repository.CompositionSearchSession
Description

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

MethodgetCompositions
Description

Gets the composition list resulting from a search.

Returnosid.repository.CompositionList the composition list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCompositionQueryInspector
Description

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

Returnosid.repository.CompositionQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCompositionSearchResultsRecord
Description

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

Parametersosid.type.TypecompositionSearchRecordType a composition search record type
Returnosid.repository.records.CompositionSearchResultsRecord the composition search results record
ErrorsNULL_ARGUMENT compositionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(compositionSearchRecordType) is false
Compliancemandatory This method must be implemented.