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

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

MethodgetBrokers
Description

Gets the broker list resulting from a search.

Returnosid.provisioning.BrokerListthe broker list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQueryInspector
Description

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

Returnosid.provisioning.BrokerQueryInspectorthe broker query inspector
CompliancemandatoryThis 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.TypebrokerSearchRecordTypea broker search record type
Returnosid.provisioning.records.BrokerSearchResultsRecordthe broker search results record
ErrorsNULL_ARGUMENT brokerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(brokerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.