OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.CompositionSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetCompositions
Description

Gets the composition list resulting from a search.

Returnosid.repository.CompositionListthe composition list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCompositionQueryInspector
Description

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

Returnosid.repository.CompositionQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypecompositionSearchRecordTypea composition search record type
Returnosid.repository.records.CompositionSearchResultsRecordthe composition search results record
ErrorsNULL_ARGUMENT compositionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(compositionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.