OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetBrokerProcessorEnablers
Description

Gets the BrokerProcessorEnablerList resulting from a search.

Returnosid.provisioning.rules.BrokerProcessorEnablerListthe broker processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerQueryInspector
Description

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

Returnosid.provisioning.rules.BrokerProcessorEnablerQueryInspectorthe broker processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypebrokerProcessorEnablerSearchRecordTypea broker processor enabler search record type
Returnosid.provisioning.rules.records.BrokerProcessorEnablerSearchResultsRecordthe broker processor enabler search results record
ErrorsNULL_ARGUMENT brokerProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(brokerProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.