OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.BrokerProcessorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.rules.BrokerProcessorSearchSession
Description

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

MethodgetBrokerProcessors
Description

Gets the broker processor list resulting from a search.

Returnosid.provisioning.rules.BrokerProcessorListthe broker processor list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorQueryInspector
Description

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

Returnosid.provisioning.rules.BrokerProcessorQueryInspectorthe broker processor query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorSearchResultsRecord
Description

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

Parametersosid.type.TypebrokerProcessorSearchRecordTypea broker processor search record type
Returnosid.provisioning.rules.records.BrokerProcessorSearchResultsRecordthe broker processor search results record
ErrorsNULL_ARGUMENTbrokerProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(brokerProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.