oracle.ifs.core.tools.script.test.overrides.activity.community

Class JoinAction

java.lang.Object

oracle.ifs.core.activity.ActionFactory

oracle.ifs.core.activity.ActionAdapter

oracle.ifs.core.tools.script.test.overrides.activity.community.JoinAction

All Implemented Interfaces:

Action

public class JoinAction
extends ActionAdapter

A JoinAction is used to perform or reflect an action taken by an Actor to become a member of a Community, or cancel the membership.

Field Summary

Fields

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_COMMUNITYMEMBER_ADDED The AuditEventTypeDefinition for the COMMUNITYMEMBER_ADDED action.
static AuditEventTypeDefinition	EVENTTYPE_COMMUNITYMEMBER_REMOVED The AuditEventTypeDefinition for the COMMUNITYMEMBER_REMOVED action.
static int	OPTYPE_COMMUNITYMEMBER_ADDED The Operation type for the COMMUNITYMEMBER_ADDED action.
static int	OPTYPE_COMMUNITYMEMBER_REMOVED The Operation type for the COMMUNITYMEMBER_REMOVED action.

Constructor Summary

Constructors

Constructor and Description
JoinAction() Constructs a JoinAction to be used as an ActionFactory.
JoinAction(ActionFactory factory) Constructs a "pending" JoinAction, to be used to execute a new Action.
JoinAction(ActionFactory factory, AuditEvent event) Constructs an "executed" JoinAction, reflecting a previously executed Action.

Method Summary

Modifier and Type	Method and Description
void	addMember(CommunityMember mem) Adds a new member, 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.
CommunityMember	getCommunityMember() Returns the CommunityMember setting for add or remove actions.
Actor	getMemberActor() Returns the Actor setting for add or remove actions.
boolean	isMemberAdded() Returns true if this action will add a member (when executed).
boolean	isMemberRemoved() Returns true if this action will remove a member (when executed).
void	preExecute() Handle anything prior to executing the Action.
void	removeMember(CommunityMember mem) Removes an existing member, prior to execution.

Methods inherited from class oracle.ifs.core.activity.ActionAdapter

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

Methods inherited from class oracle.ifs.core.activity.ActionFactory

constructActivityEventTypeDefinition, initialize, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ACTIONSPECIFICATION_NAME

public static final String DEFAULT_ACTIONSPECIFICATION_NAME

The name of the default ActionSpecification for this type of action.

See Also:

Constant Field Values

EVENTTYPE_COMMUNITYMEMBER_ADDED

public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_ADDED

The AuditEventTypeDefinition for the COMMUNITYMEMBER_ADDED action.

EVENTTYPE_COMMUNITYMEMBER_REMOVED

public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_REMOVED

The AuditEventTypeDefinition for the COMMUNITYMEMBER_REMOVED action.

OPTYPE_COMMUNITYMEMBER_ADDED

public static final int OPTYPE_COMMUNITYMEMBER_ADDED

The Operation type for the COMMUNITYMEMBER_ADDED action.

OPTYPE_COMMUNITYMEMBER_REMOVED

public static final int OPTYPE_COMMUNITYMEMBER_REMOVED

The Operation type for the COMMUNITYMEMBER_REMOVED action.

Constructor Detail

JoinAction

public JoinAction()

Constructs a JoinAction to be used as an ActionFactory.

Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.

JoinAction

public JoinAction(ActionFactory factory)
           throws IfsException

Constructs a "pending" JoinAction, to be used to execute a new Action.

Parameters:

factory - the ActionFactory used to construct this instance

Throws:

IfsException - if operation fails

JoinAction

public JoinAction(ActionFactory factory,
                  AuditEvent event)
           throws IfsException

Constructs an "executed" JoinAction, reflecting a previously executed Action.

Parameters:

factory - the ActionFactory used to construct this instance

event - The event that was posted as part of the previously executed Action.

Throws:

IfsException - if operation fails

Method Detail

constructPendingAction

public Action constructPendingAction()
                              throws IfsException

Construct an instance of an Action that is not yet executed.

Specified by:

constructPendingAction in class ActionFactory

Returns:

The Action instance, ready to be setup for subsequent execution

Throws:

IfsException - if the operation fails.

constructExecutedAction

public Action constructExecutedAction(AuditEvent event)
                               throws IfsException

Construct an instance reflecting a previously executed Action.

Specified by:

constructExecutedAction in class ActionFactory

Parameters:

event - The event that was posted as part of the previously executed Action.

Returns:

The Action instance, reflecting the previous execution

Throws:

IfsException - if the operation fails.

getAuditEventTypeDefinitions

public AuditEventTypeDefinition[] getAuditEventTypeDefinitions()

Gets the set of AuditEventTypeDefinitions for events that can be posted by this Action associated with this type of Action.

Specified by:

getAuditEventTypeDefinitions in class ActionFactory

Returns:

the definitions for event types used by this instance

clearAllSettings

public void clearAllSettings()

Clears any previously-set settings on this Action instance.

(Published)

addMember

public void addMember(CommunityMember mem)
               throws IfsException

Adds a new member, prior to execution.

The caller has already added the CommunityMember to the Community before this is called.

Parameters:

mem - the CommunityMember that was added to reflect the new membership

Throws:

IfsException - if operation fails

(Published)

removeMember

public void removeMember(CommunityMember mem)
                  throws IfsException

Removes an existing member, prior to execution.

The caller has not yet removed the CommunityMember from the Community when this is called.

Parameters:

mem - the CommunityMember that reflects the membership

Throws:

IfsException - if operation fails

(Published)

isMemberAdded

public boolean isMemberAdded()

Returns true if this action will add a member (when executed).

Returns:

true if member is being added; false otherwise

(Published)

isMemberRemoved

public boolean isMemberRemoved()

Returns true if this action will remove a member (when executed).

Returns:

true if member is being removed; false otherwise

(Published)

getMemberActor

public Actor getMemberActor()

Returns the Actor setting for add or remove actions.

Returns:

the Actor setting for add or remove

(Published)

getCommunityMember

public CommunityMember getCommunityMember()

Returns the CommunityMember setting for add or remove actions.

Returns:

the CommunityMember setting for add or remove

(Published)

preExecute

public void preExecute()
                throws IfsException

Handle anything prior to executing the Action.

This is called prior to invoking execute.

Overrides:

preExecute in class ActionAdapter

Throws:

IfsException - if the operation fails.

execute

public void execute()
             throws IfsException

Perform the Action execution.

This is called after first invoking preExecute and before invoking postExecute.

Specified by:

execute in class ActionAdapter

Throws:

IfsException - if the operation fails.