org.osid.provisioning.rules

Interface QueueProcessorEnabler

All Superinterfaces:

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

public interface QueueProcessorEnabler
extends OsidEnabler

A QueueProcessorEnabler describes the rules for making a QueueProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
QueueProcessorEnablerRecord	getQueueProcessorEnablerRecord(Type queueProcessorEnablerRecordType) Gets the queue processor enabler record corresponding to the given QueueProcessorEnabler 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

getQueueProcessorEnablerRecord

QueueProcessorEnablerRecord getQueueProcessorEnablerRecord(Type queueProcessorEnablerRecordType)
                                                           throws OperationFailedException

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

Parameters:

queueProcessorEnablerRecordType - the type of queue processor enabler record to retrieve

Returns:

the queue processor enabler record

Throws:

NullArgumentException - queueProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.