Interface DispatchConstrainerEnabler

All Superinterfaces:

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

public interface DispatchConstrainerEnabler
extends OsidEnabler

A DispatchConstrainerEnabler manages the active status of a DispatchConstrainer.

Like all OsidObjects, DispatchConstrainerEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type	Method	Description
DispatchConstrainerEnablerRecord	getDispatchConstrainerEnablerRecord(Type dispatchConstrainerEnablerRecordType)	Gets the dispatch constrainer enabler record corresponding to the given DispatchConstrainerEnabler record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface OsidEnabler

getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirement

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface OsidRule

getConditionRecordTypes, getRule, getRuleId, hasRule

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Method Details

getDispatchConstrainerEnablerRecord

DispatchConstrainerEnablerRecord getDispatchConstrainerEnablerRecord(Type dispatchConstrainerEnablerRecordType)
                                                              throws OperationFailedException

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

Parameters:

dispatchConstrainerEnablerRecordType - the type of dispatch constrainer enabler record to retrieve

Returns:

the dispatch constrainer enabler record

Throws:

NullArgumentException - dispatchConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.