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

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

MethodgetCompositionEnablers
Description

Gets the CompositionEnablerList resulting from a search.

Returnosid.repository.rules.CompositionEnablerListthe composition enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablerQueryInspector
Description

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

Returnosid.repository.rules.CompositionEnablerQueryInspectorthe composition enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypecompositionEnablerSearchRecordTypea composition enabler search record type
Returnosid.repository.rules.records.CompositionEnablerSearchResultsRecordthe composition enabler search results record
ErrorsNULL_ARGUMENT compositionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(compositionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.