OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.CompositionSearch
Implementsosid.OsidSearch
Used Byosid.repository.CompositionSearchSession
Description

The interface for governing composition searches.

MethodsearchAmongCompositions
Description

Execute this search among the given list of compositions.

Parametersosid.id.IdListcompositionIds list of compositions
ErrorsNULL_ARGUMENT compositionIds is null
Compliancemandatory This method must be implemented.
MethodorderCompositionResults
Description

Specify an ordering to the search results.

Parametersosid.repository.CompositionSearchOrdercompositionSearchOrder composition search order
ErrorsNULL_ARGUMENT compositionSearchOrder is null
UNSUPPORTED compositionSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCompositionSearchRecord
Description

Gets the composition search 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.CompositionSearchRecord the composition search record
ErrorsNULL_ARGUMENT compositionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(compositionSearchRecordType) is false
Compliancemandatory This method must be implemented.