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

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

MethodgetBrokerProcessors
Description

Gets the BrokerProcessorList resulting from a search.

Returnosid.provisioning.rules.BrokerProcessorListthe broker processor list
ErrorsILLEGAL_STATElist has already been 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 must be 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_ARGUMENT brokerProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(brokerProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.