public class BinaryDeviceAction extends ActionAdapter
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ACTIONSPECIFICATION_NAME
The name of the default ActionSpecification for this type of action.
|
static AuditEventTypeDefinition |
EVENTTYPE_BINARYDEVICE_TURNED_OFF
The AuditEventTypeDefinition for the BINARYDEVICE_TURNED_OFF action.
|
static AuditEventTypeDefinition |
EVENTTYPE_BINARYDEVICE_TURNED_ON
The AuditEventTypeDefinition for the BINARYDEVICE_TURNED_ON action.
|
static int |
OPTYPE_OFF
The Operation type for the BINARYDEVICE_TURNED_OFF action.
|
static int |
OPTYPE_ON
The Operation type for the BINARYDEVICE_TURNED_ON action.
|
Constructor and Description |
---|
BinaryDeviceAction()
Constructs a BinaryDeviceAction to be used as an ActionFactory.
|
BinaryDeviceAction(ActionFactory factory)
Constructs a "pending" BinaryDeviceAction, to be used to execute a new Action.
|
BinaryDeviceAction(ActionFactory factory,
AuditEvent event)
Constructs an "executed" BinaryDeviceAction, reflecting a previously
executed Action.
|
Modifier and Type | Method and Description |
---|---|
void |
clearAllSettings()
Clears any previously-set settings on this Action instance.
|
Action |
constructExecutedAction(AuditEvent event)
Construct an instance reflecting a previously executed Action.
|
Action |
constructPendingAction()
Construct an instance of an Action that is not yet executed.
|
void |
execute()
Perform the Action execution.
|
AuditEventTypeDefinition[] |
getAuditEventTypeDefinitions()
Gets the set of AuditEventTypeDefinitions for events
that can be posted by this Action associated with this type of Action.
|
boolean |
isOffSet()
Returns true if this action will set an OFF (when executed).
|
boolean |
isOnSet()
Returns true if this action will set an ON (when executed).
|
void |
setOff()
Sets a "OFF" indication, prior to execution.
|
void |
setOn()
Sets a "ON" indication, prior to execution.
|
calculateOperationType, dispatchEvent, dispatchEvent, dispatchEvent, dispatchEvent, execute, execute, getActionSpecification, getActionSpecificationId, getActivityRecord, getActor, getAuditEventId, getAuditOperationType, getAuditOperationTypeKey, getAuxiliaryObjects, getAuxiliaryString, getExecutingUserId, getExecutionDate, getFirstAuxiliaryObject, getInstance, getInstance, getPerformedActivityRecord, getProperties, getPropertyTable, getSecondAuxiliaryObject, getSession, getTrackedActivityRecord, isActivityRecordFreed, isActivityRecordUndiscoverable, isActorFreed, isActorUndiscoverable, isFactory, isPendingExecution, isPreviouslyExecuted, postExecute, preExecute, setExecutingActionType
constructActivityEventTypeDefinition, initialize, isInitialized
public static final String DEFAULT_ACTIONSPECIFICATION_NAME
public static final AuditEventTypeDefinition EVENTTYPE_BINARYDEVICE_TURNED_ON
public static final AuditEventTypeDefinition EVENTTYPE_BINARYDEVICE_TURNED_OFF
public static final int OPTYPE_ON
public static final int OPTYPE_OFF
public BinaryDeviceAction()
Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
public BinaryDeviceAction(ActionFactory factory) throws IfsException
factory
- the ActionFactory used to construct this instanceIfsException
- if operation failspublic BinaryDeviceAction(ActionFactory factory, AuditEvent event) throws IfsException
factory
- the ActionFactory used to construct this instanceevent
- The event that was posted as part of the
previously executed Action.IfsException
- if operation failspublic Action constructPendingAction() throws IfsException
constructPendingAction
in class ActionFactory
IfsException
- if the operation fails.public Action constructExecutedAction(AuditEvent event) throws IfsException
constructExecutedAction
in class ActionFactory
event
- The event that was posted as part of the
previously executed Action.IfsException
- if the operation fails.public AuditEventTypeDefinition[] getAuditEventTypeDefinitions()
getAuditEventTypeDefinitions
in class ActionFactory
public void clearAllSettings()
public void setOn()
public void setOff()
public boolean isOnSet()
public boolean isOffSet()
public void execute() throws IfsException
This is called after first invoking preExecute
and before
invoking postExecute
.
execute
in class ActionAdapter
IfsException
- if the operation fails.Copyright © 2023. All rights reserved.