OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.BrokerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.BrokerSearchSession
Description

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

MethodgetBrokers
Description

Gets the broker list resulting from a search.

Returnosid.provisioning.BrokerList the broker list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetBrokerQueryInspector
Description

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

Returnosid.provisioning.BrokerQueryInspector the broker query inspector
Compliancemandatory This method must be implemented.
MethodgetBrokerSearchResultsRecord
Description

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

Parametersosid.type.TypebrokerSearchRecordType a broker search record type
Returnosid.provisioning.records.BrokerSearchResultsRecord the broker search results record
ErrorsNULL_ARGUMENT brokerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(brokerSearchRecordType) is false
Compliancemandatory This method must be implemented.