public class IncludeActorAction extends ActionAdapter
Modifier and Type | Field and Description |
---|---|
static AuditEventTypeDefinition |
EVENTTYPE_INCLUDED_ACTOR_ADDED
The AuditEventTypeDefinition for the INCLUDED_ACTOR_ADDED action.
|
static AuditEventTypeDefinition |
EVENTTYPE_INCLUDED_ACTOR_REMOVED
The AuditEventTypeDefinition for the INCLUDED_ACTOR_REMOVED action.
|
Constructor and Description |
---|
IncludeActorAction()
Constructs a IncludeActorAction to be used as an ActionFactory.
|
IncludeActorAction(ActionFactory factory)
Constructs a "pending" IncludeActorAction, to be used to execute a new Action.
|
IncludeActorAction(ActionFactory factory,
AuditEvent event)
Constructs an "executed" IncludeActorAction, reflecting a previously
executed Action.
|
Modifier and Type | Method and Description |
---|---|
void |
addIncludedActor(Actor actor)
Adds an included Actor, 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 |
getAuditEventTypeDefinitionForAdd()
Gets the AuditEventTypeDefinition that should be used when executing a
"Included Actor added" action.
|
AuditEventTypeDefinition |
getAuditEventTypeDefinitionForRemove()
Gets the AuditEventTypeDefinition that should be used when executing a
"Included Actor removed" action.
|
AuditEventTypeDefinition[] |
getAuditEventTypeDefinitions()
Gets the set of AuditEventTypeDefinitions for events
that can be posted by this Action associated with this type of Action.
|
Actor |
getIncludedActor()
Returns the included Actor setting for add or remove actions.
|
boolean |
isIncludedActorAdded()
Returns true if this action will add an included Actor (when executed).
|
boolean |
isIncludedActorRemoved()
Returns true if this action will remove an included Actor (when executed).
|
void |
removeIncludedActor(Actor actor)
Removes an included Actor, 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 AuditEventTypeDefinition EVENTTYPE_INCLUDED_ACTOR_ADDED
public static final AuditEventTypeDefinition EVENTTYPE_INCLUDED_ACTOR_REMOVED
public IncludeActorAction()
Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
public IncludeActorAction(ActionFactory factory) throws IfsException
factory
- the ActionFactory used to construct this instanceIfsException
- if operation failspublic IncludeActorAction(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 AuditEventTypeDefinition getAuditEventTypeDefinitionForAdd()
public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()
public void clearAllSettings()
public void addIncludedActor(Actor actor) throws IfsException
actor
- the included ActorIfsException
- if operation failspublic void removeIncludedActor(Actor actor) throws IfsException
actor
- the included ActorIfsException
- if operation failspublic boolean isIncludedActorAdded()
public boolean isIncludedActorRemoved()
public Actor getIncludedActor()
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.