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

Class RecommendMembershipAction

java.lang.Object

oracle.ifs.core.activity.ActionFactory

oracle.ifs.core.activity.ActionAdapter

oracle.ifs.core.activity.RecommendAction

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

All Implemented Interfaces:

Action

public class RecommendMembershipAction
extends RecommendAction

A RecommendMembershipAction is subclass of RecommendAction used to record information about the recommending Community membership to another Actor.

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_RECOMMENDATION_ADDED The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_ADDED action.
static AuditEventTypeDefinition	EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_REMOVED The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_REMOVED action.

Fields inherited from class oracle.ifs.core.activity.RecommendAction

EVENTTYPE_RECOMMENDATION_ADDED, EVENTTYPE_RECOMMENDATION_REMOVED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRecommendation(Actor actor, String comment) Adds a recommendation, prior to execution.
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.
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.
String	getComment() Gets the comment.
AttributeValue[]	getEventProperties() Gets any event properties to post with the AuditEvents.

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

addRecommendation, clearAllSettings, execute, getRecommendedActor, isRecommendationAdded, isRecommendationRemoved, removeRecommendation

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_COMMUNITYMEMBER_RECOMMENDATION_ADDED

public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_ADDED

The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_ADDED action.

EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_REMOVED

public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_REMOVED

The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_REMOVED action.

Constructor Detail

RecommendMembershipAction

public RecommendMembershipAction()

Constructs a RecommendMembershipAction to be used as an ActionFactory.

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

RecommendMembershipAction

public RecommendMembershipAction(ActionFactory factory)
                          throws IfsException

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

Parameters:

factory - the ActionFactory used to construct this instance

Throws:

IfsException - if operation fails

RecommendMembershipAction

public RecommendMembershipAction(ActionFactory factory,
                                 AuditEvent event)
                          throws IfsException

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

Overrides:

constructPendingAction in class RecommendAction

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.

Overrides:

constructExecutedAction in class RecommendAction

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.

addRecommendation

public void addRecommendation(Actor actor,
                              String comment)
                       throws IfsException

Adds a recommendation, prior to execution.

Parameters:

actor - the recommended Actor

comment - the comment that should accompany the recommendation

Throws:

IfsException - if operation fails

(Published)

getComment

public String getComment()
                  throws IfsException

Gets the comment.

Returns:

the comment that accompanied the recommendation

Throws:

IfsException - if operation fails

(Published)

getAuditEventTypeDefinitions

public AuditEventTypeDefinition[] getAuditEventTypeDefinitions()

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

Overrides:

getAuditEventTypeDefinitions in class RecommendAction

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.

Overrides:

getAuditEventTypeDefinitionForAdd in class RecommendAction

Returns:

the AuditEventTypeDefinition to use when adding

getAuditEventTypeDefinitionForRemove

public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()

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

Overrides:

getAuditEventTypeDefinitionForRemove in class RecommendAction

Returns:

the AuditEventTypeDefinition to use when removing

getEventProperties

public AttributeValue[] getEventProperties()
                                    throws IfsException

Gets any event properties to post with the AuditEvents.

Overrides:

getEventProperties in class RecommendAction

Returns:

the event properties to post

Throws:

IfsException