oracle.ifs.core.activity.social

Class FollowAction

java.lang.Object

oracle.ifs.core.activity.ActionFactory

oracle.ifs.core.activity.ActionAdapter

oracle.ifs.core.activity.social.FollowAction

All Implemented Interfaces:

Action

public class FollowAction
extends ActionAdapter

A FollowAction is used to perform or reflect an action taken by an Actor to indicate that the Actor wants to "follow" an item.

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_FOLLOW_ADDED The AuditEventTypeDefinition for the FOLLOW_ADDED action.
static AuditEventTypeDefinition	EVENTTYPE_FOLLOW_REMOVED The AuditEventTypeDefinition for the FOLLOW_REMOVED action.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addFollow() Adds a "Follow" indication, 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 "follow added" action.
AuditEventTypeDefinition	getAuditEventTypeDefinitionForRemove() Gets the AuditEventTypeDefinition that should be used when executing a "follow removed" action.
AuditEventTypeDefinition[]	getAuditEventTypeDefinitions() Gets the set of AuditEventTypeDefinitions for events that can be posted by this Action associated with this type of Action.
boolean	isFollowAdded() Returns true if this action will ADD a follow (when executed).
boolean	isFollowRemoved() Returns true if this action will REMOVE a follow (when executed).
void	removeFollow() Removes a "Follow" indication, 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, preExecute, 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_FOLLOW_ADDED

public static final AuditEventTypeDefinition EVENTTYPE_FOLLOW_ADDED

The AuditEventTypeDefinition for the FOLLOW_ADDED action.

EVENTTYPE_FOLLOW_REMOVED

public static final AuditEventTypeDefinition EVENTTYPE_FOLLOW_REMOVED

The AuditEventTypeDefinition for the FOLLOW_REMOVED action.

Constructor Detail

FollowAction

public FollowAction()

Constructs a FollowAction to be used as an ActionFactory.

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

FollowAction

public FollowAction(ActionFactory factory)
             throws IfsException

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

Parameters:

factory - the ActionFactory used to construct this instance

Throws:

IfsException - if operation fails

FollowAction

public FollowAction(ActionFactory factory,
                    AuditEvent event)
             throws IfsException

Constructs an "executed" FollowAction, 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

getAuditEventTypeDefinitionForAdd

public AuditEventTypeDefinition getAuditEventTypeDefinitionForAdd()

Gets the AuditEventTypeDefinition that should be used when executing a "follow added" action.

Returns:

the AuditEventTypeDefinition to use when adding

getAuditEventTypeDefinitionForRemove

public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()

Gets the AuditEventTypeDefinition that should be used when executing a "follow removed" action.

Returns:

the AuditEventTypeDefinition to use when removing

clearAllSettings

public void clearAllSettings()

Clears any previously-set settings on this Action instance.

(Published)

addFollow

public void addFollow()

Adds a "Follow" indication, prior to execution.

(Published)

removeFollow

public void removeFollow()

Removes a "Follow" indication, prior to execution.

(Published)

isFollowAdded

public boolean isFollowAdded()

Returns true if this action will ADD a follow (when executed).

Returns:

true if follow is being added; false otherwise

(Published)

isFollowRemoved

public boolean isFollowRemoved()

Returns true if this action will REMOVE a follow (when executed).

Returns:

true if follow is being removed; false otherwise

(Published)

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.