OSID Logo
OSID Specifications
configuration rules package
Version 3.1.0
Interfaceosid.configuration.rules.ValueEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.configuration.rules.ValueEnablerSearchSession
Description

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

MethodgetValueEnablers
Description

Gets the ValueEnablerList resulting from a search.

Returnosid.configuration.rules.ValueEnablerList the value enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetValueEnablerQueryInspector
Description

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

Returnosid.configuration.rules.ValueEnablerQueryInspector the value enabler query inspector
Compliancemandatory This 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.TypevalueEnablerSearchRecordType a value enabler search record type
Returnosid.configuration.rules.records.ValueEnablerSearchResultsRecord the value enabler search results record
ErrorsNULL_ARGUMENT valueEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(valueEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.