org.osid.provisioning.rules

Interface BrokerConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface BrokerConstrainer
extends OsidConstrainer

A BrokerConstrainer describes the rules for constraining the pools and queues allowed in a broker.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerConstrainerRecord	getBrokerConstrainerRecord(Type brokerConstrainerRecordType) Gets the broker constrainer record corresponding to the given BrokerConstrainer record Type.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getBrokerConstrainerRecord

BrokerConstrainerRecord getBrokerConstrainerRecord(Type brokerConstrainerRecordType)
                                                   throws OperationFailedException

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

Parameters:

brokerConstrainerRecordType - the type of broker constrainer record to retrieve

Returns:

the broker constrainer record

Throws:

NullArgumentException - brokerConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.