public interface SignalEnabler extends OsidEnabler
A SignalEnabler
describes the rules for enabling
signals.
Modifier and Type | Method and Description |
---|---|
SignalEnablerRecord |
getSignalEnablerRecord(Type signalEnablerRecordType)
Gets the signal enabler record corresponding to the given
SignalEnabler record Type. |
getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getEndDate, getStartDate, isEffective
SignalEnablerRecord getSignalEnablerRecord(Type signalEnablerRecordType) throws OperationFailedException
SignalEnabler
record Type.
This method is used
to retrieve an object implementing the requested record. The
signalEnablerRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(signalEnablerRecordType)
is true
.signalEnablerRecordType
- the type of signal enabler record to
retrieveNullArgumentException
- signalEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalEnablerRecordType)
is false
mandatory
- This method must be implemented.