OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.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.TypebrokerEnablerRecordType the type of broker enabler record to retrieve
Returnosid.provisioning.rules.records.BrokerEnablerRecord the broker enabler record
ErrorsNULL_ARGUMENT brokerEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(brokerEnablerRecordType) is false
Compliancemandatory This method must be implemented.