org.osid.provisioning.rules

Interface BrokerProcessorEnabler

All Superinterfaces:

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

public interface BrokerProcessorEnabler
extends OsidEnabler

A BrokerProcessorEnabler describes the rules for making a BrokerProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerProcessorEnablerRecord	getBrokerProcessorEnablerRecord(Type brokerProcessorEnablerRecordType) Gets the broker processor enabler record corresponding to the given BrokerProcessorEnabler 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

getBrokerProcessorEnablerRecord

BrokerProcessorEnablerRecord getBrokerProcessorEnablerRecord(Type brokerProcessorEnablerRecordType)
                                                             throws OperationFailedException

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

Parameters:

brokerProcessorEnablerRecordType - the type of broker processor enabler record to retrieve

Returns:

the broker processor enabler record

Throws:

NullArgumentException - brokerProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.