OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ValueEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetValueEnablers
Description

Gets the ValueEnablerList resulting from a search.

Returnosid.configuration.rules.ValueEnablerListthe value enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerQueryInspector
Description

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

Returnosid.configuration.rules.ValueEnablerQueryInspectorthe value enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypevalueEnablerSearchRecordTypea value enabler search record type
Returnosid.configuration.rules.records.ValueEnablerSearchResultsRecordthe value enabler search results record
ErrorsNULL_ARGUMENT valueEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(valueEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.