OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.BrokerConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.rules.BrokerConstrainerSearchSession
Description

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

MethodgetBrokerConstrainers
Description

Gets the broker constrainer list resulting from a search.

Returnosid.provisioning.rules.BrokerConstrainerListthe broker constrainer list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerQueryInspector
Description

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

Returnosid.provisioning.rules.BrokerConstrainerQueryInspectorthe broker constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerSearchResultsRecord
Description

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

Parametersosid.type.TypebrokerConstrainerSearchRecordTypea broker constrainer search record type
Returnosid.provisioning.rules.records.BrokerConstrainerSearchResultsRecordthe broker constrainer search results record
ErrorsNULL_ARGUMENTbrokerConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(brokerConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.