org.osid.provisioning.rules

Interface QueueConstrainerEnabler

All Superinterfaces:

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

public interface QueueConstrainerEnabler
extends OsidEnabler

A QueueConstrainerEnabler describes the rules for making a QueueConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
QueueConstrainerEnablerRecord	getQueueConstrainerEnablerRecord(Type queueConstrainerEnablerRecordType) Gets the queue constrainer enabler record corresponding to the given QueueConstrainerEnabler 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

getQueueConstrainerEnablerRecord

QueueConstrainerEnablerRecord getQueueConstrainerEnablerRecord(Type queueConstrainerEnablerRecordType)
                                                               throws OperationFailedException

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

Parameters:

queueConstrainerEnablerRecordType - the type of queue constrainer enabler record to retrieve

Returns:

the queue constrainer enabler record

Throws:

NullArgumentException - queueConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.