public interface ActionEnabler extends OsidEnabler
An ActionEnabler
describes the rules for making an
ControlConstrainer
effective.
Modifier and Type | Method and Description |
---|---|
ActionEnablerRecord |
getActionEnablerRecord(Type actionEnablerRecordType)
Gets the action enabler record corresponding to the given
ActionEnabler 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
ActionEnablerRecord getActionEnablerRecord(Type actionEnablerRecordType) throws OperationFailedException
ActionEnabler
record Type.
This method is used
to retrieve an object implementing the requested record. The
actionEnablerRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(actionEnablerRecordType)
is true
.actionEnablerRecordType
- the type of action enabler record to
retrieveNullArgumentException
- actionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionEnablerRecordType)
is false
mandatory
- This method must be implemented.