org.osid.provisioning.rules

Interface BrokerConstrainerEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface BrokerConstrainerEnabler
extends OsidEnabler

A BrokerConstrainerEnabler describes the rules for making a BrokerConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerConstrainerEnablerRecord	getBrokerConstrainerEnablerRecord(Type brokerConstrainerEnablerRecordType) Gets the broker constrainer enabler record corresponding to the given BrokerConstrainerEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getBrokerConstrainerEnablerRecord

BrokerConstrainerEnablerRecord getBrokerConstrainerEnablerRecord(Type brokerConstrainerEnablerRecordType)
                                                                 throws OperationFailedException

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

Parameters:

brokerConstrainerEnablerRecordType - the type of broker constrainer enabler record to retrieve

Returns:

the broker constrainer enabler record

Throws:

NullArgumentException - brokerConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.