OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.CompositionSearch
Implementsosid.OsidSearch
Description

The interface for governing composition searches.

MethodsearchAmongCompositions
Description

Execute this search among the given list of compositions.

Parametersosid.id.IdListcompositionIdslist of compositions
ErrorsNULL_ARGUMENT compositionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCompositionResults
Description

Specify an ordering to the search results.

Parametersosid.repository.CompositionSearchOrdercompositionSearchOrdercomposition search order
ErrorsNULL_ARGUMENT compositionSearchOrder is null
UNSUPPORTED compositionSearchOrder is not of this service
CompliancemandatoryThis 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.TypecompositionSearchRecordTypea composition search record type
Returnosid.repository.records.CompositionSearchRecordthe composition search record
ErrorsNULL_ARGUMENT compositionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(compositionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.