public interface Action extends OsidRule, Subjugateable
An Action
executes a Scene, Setting,
another ActionGroup,
or other Rule
. An
Action
is also an OsidRule
that may or may
not be active.
Modifier and Type | Method and Description |
---|---|
boolean |
executesActionGroup()
Tests if this rule executes a scene.
|
boolean |
executesMatchingSetting()
Tests if this rule executes a matching setting.
|
boolean |
executesScene()
Tests if this rule executes a scene.
|
boolean |
executesSetting()
Tests if this rule executes a setting.
|
ActionGroup |
getActionGroup()
Gets the action group for this action.
|
Id |
getActionGroupId()
Gets the action group
Id for this action. |
ActionRecord |
getActionRecord(Type actionRecordType)
Gets the action record corresponding to the given
Action
record Type. |
Duration |
getDelay()
Gets the delay before proceeding with execution.
|
java.math.BigDecimal |
getMatchingAmountFactor()
Gets the factor by which the matching amount differs.
|
Controller |
getMatchingController()
Gets the matching controller.
|
Id |
getMatchingControllerId()
Gets the matching controller
Id. |
java.math.BigDecimal |
getMatchingRateFactor()
Gets the factor by which the matching transition rate differs.
|
ActionGroup |
getNextActionGroup()
Gets the action group to execute,
|
Id |
getNextActionGroupId()
Gets the action group
Id to execute. |
Scene |
getScene()
Gets the scene.
|
Id |
getSceneId()
Gets the scene
Id. |
Setting |
getSetting()
Gets the setting.
|
Id |
getSettingId()
Gets the setting
Id. |
boolean |
isBlocking()
Tests if this action blocks further actions until complete.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getActionGroupId()
Id
for this action. Id
mandatory
- This method must be implemented. ActionGroup getActionGroup() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getDelay()
mandatory
- This method must be implemented. boolean isBlocking()
true
if blocking, false
if
subsequent actions can begin before this action completesmandatory
- This method must be implemented. boolean executesActionGroup()
executesActionGroup()
is true,
hasRule(), executesScene(),
executesSetting(),
and executesMatchingSetting()
must be false.
true
if this is a scene execution, false
otherwisemandatory
- This method must be implemented. Id getNextActionGroupId()
Id
to execute. Id
IllegalStateException
- executesActionGroup()
is false
mandatory
- This method must be implemented. ActionGroup getNextActionGroup() throws OperationFailedException
IllegalStateException
- executesActionGroup()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean executesScene()
executesScene()
is true,
hasRule(), executesActionGroup(),
executesSetting(),
and executesMatchingSetting()
must be false.
true
if this is a scene execution, false
otherwisemandatory
- This method must be implemented. Id getSceneId()
Id.
Id
IllegalStateException
- executesScene()
is false
mandatory
- This method must be implemented. Scene getScene() throws OperationFailedException
IllegalStateException
- executesScene()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean executesSetting()
executesSetting()
is true,
hasRule(),
executesActionGroup(), executesScene(),
and
executesMatchingSetting()
must be false.
true
if this is a setting execution,
false
otherwisemandatory
- This method must be implemented. Id getSettingId()
Id.
Id
IllegalStateException
- executesSetting()
is false
mandatory
- This method must be implemented. Setting getSetting() throws OperationFailedException
IllegalStateException
- executesSetting()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean executesMatchingSetting()
executesMatchingSetting()
is true,
hasRule(),
executesScene(), executesActionGroup(),
and executesSetting()
must be false.
true
if this is a setting execution,
false
otherwisemandatory
- This method must be implemented. Id getMatchingControllerId()
Id.
Id
IllegalStateException
-
executesMatchingSetting()
is false
mandatory
- This method must be implemented. Controller getMatchingController() throws OperationFailedException
IllegalStateException
-
executesMatchingSetting()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getMatchingAmountFactor()
IllegalStateException
-
executesMatchingSetting()
is false
mandatory
- This method must be implemented. java.math.BigDecimal getMatchingRateFactor()
IllegalStateException
-
executesMatchingSetting()
is false
mandatory
- This method must be implemented. ActionRecord getActionRecord(Type actionRecordType) throws OperationFailedException
Action
record Type.
This method is used to retrieve an
object implementing the requested record. The actionRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(actionRecordType)
is true
.actionRecordType
- the type of action record to retrieveNullArgumentException
- actionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionRecordType)
is false
mandatory
- This method must be implemented.