oracle.ifs.core.activity

Class RecommendAction

java.lang.Object

oracle.ifs.core.activity.ActionFactory

oracle.ifs.core.activity.ActionAdapter

oracle.ifs.core.activity.RecommendAction

All Implemented Interfaces:

Action

Direct Known Subclasses:

RecommendMembershipAction

public class RecommendAction
extends ActionAdapter

A RecommendAction is used to perform or reflect an action taken by an Actor to recommend an ActivityRecord to another Actor.

Field Summary

Fields

Modifier and Type	Field and Description
static AuditEventTypeDefinition	EVENTTYPE_RECOMMENDATION_ADDED The AuditEventTypeDefinition for the RECOMMENDATION_ADDED action.
static AuditEventTypeDefinition	EVENTTYPE_RECOMMENDATION_REMOVED The AuditEventTypeDefinition for the RECOMMENDATION_REMOVED action.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRecommendation(Actor actor) Adds a recommendation, 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 "recommendation added" action.
AuditEventTypeDefinition	getAuditEventTypeDefinitionForRemove() Gets the AuditEventTypeDefinition that should be used when executing a "recommendation removed" action.
AuditEventTypeDefinition[]	getAuditEventTypeDefinitions() Gets the set of AuditEventTypeDefinitions for events that can be posted by this Action associated with this type of Action.
AttributeValue[]	getEventProperties() Gets any event properties to post with the AuditEvents.
Actor	getRecommendedActor() Returns the recommended Actor setting for add or remove actions.
boolean	isRecommendationAdded() Returns true if this action will add a recommendation (when executed).
boolean	isRecommendationRemoved() Returns true if this action will remove a recommendation (when executed).
void	removeRecommendation(Actor actor) Removes a recommendation, 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

EVENTTYPE_RECOMMENDATION_ADDED

public static final AuditEventTypeDefinition EVENTTYPE_RECOMMENDATION_ADDED

The AuditEventTypeDefinition for the RECOMMENDATION_ADDED action.

EVENTTYPE_RECOMMENDATION_REMOVED

public static final AuditEventTypeDefinition EVENTTYPE_RECOMMENDATION_REMOVED

The AuditEventTypeDefinition for the RECOMMENDATION_REMOVED action.

Constructor Detail

RecommendAction

public RecommendAction()

Constructs a RecommendAction to be used as an ActionFactory.

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

RecommendAction

public RecommendAction(ActionFactory factory)
                throws IfsException

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

Parameters:

factory - the ActionFactory used to construct this instance

Throws:

IfsException - if operation fails

RecommendAction

public RecommendAction(ActionFactory factory,
                       AuditEvent event)
                throws IfsException

Constructs an "executed" RecommendAction, 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 "recommendation added" action.

Returns:

the AuditEventTypeDefinition to use when adding

getAuditEventTypeDefinitionForRemove

public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()

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

Returns:

the AuditEventTypeDefinition to use when removing

getEventProperties

public AttributeValue[] getEventProperties()
                                    throws IfsException

Gets any event properties to post with the AuditEvents.

Returns:

the event properties to post

Throws:

IfsException

clearAllSettings

public void clearAllSettings()

Clears any previously-set settings on this Action instance.

(Published)

addRecommendation

public void addRecommendation(Actor actor)
                       throws IfsException

Adds a recommendation, prior to execution.

Parameters:

actor - the recommended Actor

Throws:

IfsException - if operation fails

(Published)

removeRecommendation

public void removeRecommendation(Actor actor)
                          throws IfsException

Removes a recommendation, prior to execution.

Parameters:

actor - the previously recommended Actor

Throws:

IfsException - if operation fails

(Published)

isRecommendationAdded

public boolean isRecommendationAdded()

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

Returns:

true if recommendation is being added; false otherwise

(Published)

isRecommendationRemoved

public boolean isRecommendationRemoved()

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

Returns:

true if recommendation is being removed; false otherwise

(Published)

getRecommendedActor

public Actor getRecommendedActor()

Returns the recommended Actor setting for add or remove actions.

Returns:

the recommended Actor setting for add or remove

(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.