OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.BrokerEnabler
Implementsosid.OsidEnabler
Used Byosid.provisioning.rules.BrokerEnablerAdminSession
osid.provisioning.rules.BrokerEnablerList
osid.provisioning.rules.BrokerEnablerLookupSession
Description

A BrokerEnabler manages the active status of a Broker.

MethodgetBrokerEnablerRecord
Description

Gets the broker enabler record corresponding to the given BrokerEnabler record Type . This method ie used to retrieve an object implementing the requested record. The brokerEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(brokerEnablerRecordType) is true .

Parametersosid.type.TypebrokerEnablerRecordTypethe type of broker enabler record to retrieve
Returnosid.provisioning.rules.records.BrokerEnablerRecordthe broker enabler record
ErrorsNULL_ARGUMENTbrokerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(brokerEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.