public class SmartHomeAction 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_SMARTHOME_ITEM_ADDED
The AuditEventTypeDefinition for the SMARTHOME_ITEM_ADDED action.
|
static int |
OPTYPE_SMARTHOME_ITEM_ADDED
The Operation type for the SMARTHOME_ITEM_ADDED action.
|
Constructor and Description |
---|
SmartHomeAction()
Constructs a SmartHomeAction to be used as an ActionFactory.
|
SmartHomeAction(ActionFactory factory)
Constructs a "pending" SmartHomeAction, to be used to execute a new Action.
|
SmartHomeAction(ActionFactory factory,
AuditEvent event)
Constructs an "executed" SmartHomeAction, reflecting a previously
executed Action.
|
Modifier and Type | Method and Description |
---|---|
void |
addItem(SmartHomeItem shItem)
Adds a new SmartHomeItem, prior to execution.
|
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.
|
SmartHomeItem |
getItem()
Returns the SmartHomeItem setting for add actions.
|
boolean |
isItemAdded()
Returns true if this action will add a SmartHomeItem (when executed).
|
void |
preExecute()
Handle anything prior to executing the Action.
|
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, setExecutingActionType
constructActivityEventTypeDefinition, initialize, isInitialized
public static final String DEFAULT_ACTIONSPECIFICATION_NAME
public static final AuditEventTypeDefinition EVENTTYPE_SMARTHOME_ITEM_ADDED
public static final int OPTYPE_SMARTHOME_ITEM_ADDED
public SmartHomeAction()
Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
public SmartHomeAction(ActionFactory factory) throws IfsException
factory
- the ActionFactory used to construct this instanceIfsException
- if operation failspublic SmartHomeAction(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 addItem(SmartHomeItem shItem) throws IfsException
The caller has already added the added the SmartHomeItem to the SmartHome before this is called.
shItem
- the new SmartHomeItemIfsException
- if operation failspublic boolean isItemAdded()
public SmartHomeItem getItem()
public void preExecute() throws IfsException
This is called prior to invoking execute
.
preExecute
in class ActionAdapter
IfsException
- if the operation fails.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.