oracle.ifs.core.activity

Class MessageAction

java.lang.Object

oracle.ifs.core.activity.ActionFactory

oracle.ifs.core.activity.ActionAdapter

oracle.ifs.core.activity.MessageAction

All Implemented Interfaces:

Action

Direct Known Subclasses:

CommentAction, ConverseAction

public class MessageAction
extends ActionAdapter

A MessageAction is used to perform or reflect an action taken by an Actor to add MessageEntries to the main MessageList of an ActivityRecord.

Field Summary

Fields

Modifier and Type	Field and Description
static AuditEventTypeDefinition	EVENTTYPE_MESSAGE_ADDED The AuditEventTypeDefinition for the MESSAGE_ADDED action.
static AuditEventTypeDefinition	EVENTTYPE_MESSAGE_EDITED The AuditEventTypeDefinition for the MESSAGE_EDITED action.
static AuditEventTypeDefinition	EVENTTYPE_MESSAGE_REMOVED The AuditEventTypeDefinition for the MESSAGE_REMOVED action.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAttachment(Document doc) Adds an attachment, prior to execution.
void	addMessage(MessageEntry me) Adds a new message, prior to execution.
void	addMessage(MessageEntry me, MessageEntry meRef) Adds a new message, 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	editMessage(MessageEntry me) Edits an existing message, prior to execution.
void	execute() Perform the Action execution.
List<Document>	getAttachementList() Returns the list of attachments for ad and edit actions
AuditEventTypeDefinition	getAuditEventTypeDefinitionForAdd() Gets the AuditEventTypeDefinition that should be used when executing a "message added" action.
AuditEventTypeDefinition	getAuditEventTypeDefinitionForEdit() Gets the AuditEventTypeDefinition that should be used when executing a "message edit" action.
AuditEventTypeDefinition	getAuditEventTypeDefinitionForRemove() Gets the AuditEventTypeDefinition that should be used when executing a "message 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	getMessage() Returns the message setting.
MessageEntry	getMessageEntry() Returns the MessageEntry setting for edit or remove actions.
String	getMessageEntryName() Returns the MessageEntry name setting.
MessageEntry	getReferencedMessageEntry() Returns the MessageEntry reference, for messages that are "in reply to" another MessageEntry.
boolean	isMessageAdded() Returns true if this action will add a message (when executed).
boolean	isMessageEdited() Returns true if this action will edit a message (when executed).
boolean	isMessageRemoved() Returns true if this action will remove a message (when executed).
void	removeMessage(MessageEntry me) Removes an existing message, 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_MESSAGE_ADDED

public static final AuditEventTypeDefinition EVENTTYPE_MESSAGE_ADDED

The AuditEventTypeDefinition for the MESSAGE_ADDED action.

EVENTTYPE_MESSAGE_EDITED

public static final AuditEventTypeDefinition EVENTTYPE_MESSAGE_EDITED

The AuditEventTypeDefinition for the MESSAGE_EDITED action.

EVENTTYPE_MESSAGE_REMOVED

public static final AuditEventTypeDefinition EVENTTYPE_MESSAGE_REMOVED

The AuditEventTypeDefinition for the MESSAGE_REMOVED action.

Constructor Detail

MessageAction

public MessageAction()

Constructs a MessageAction to be used as an ActionFactory.

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

MessageAction

public MessageAction(ActionFactory factory)
              throws IfsException

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

Parameters:

factory - the ActionFactory used to construct this instance

Throws:

IfsException - if operation fails

MessageAction

public MessageAction(ActionFactory factory,
                     AuditEvent event)
              throws IfsException

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

Returns:

the AuditEventTypeDefinition to use when adding

getAuditEventTypeDefinitionForRemove

public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()

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

Returns:

the AuditEventTypeDefinition to use when removing

getAuditEventTypeDefinitionForEdit

public AuditEventTypeDefinition getAuditEventTypeDefinitionForEdit()

Gets the AuditEventTypeDefinition that should be used when executing a "message edit" action.

Returns:

the AuditEventTypeDefinition to use when removing

clearAllSettings

public void clearAllSettings()

Clears any previously-set settings on this Action instance.

(Published)

addMessage

public void addMessage(MessageEntry me)
                throws IfsException

Adds a new message, prior to execution.

The new ME will not reference another MessageEntry.

Parameters:

me - the MessageEntry that represents the message to add

Throws:

IfsException - if operation fails

(Published)

addMessage

public void addMessage(MessageEntry me,
                       MessageEntry meRef)
                throws IfsException

Adds a new message, prior to execution.

The new ME will reference the specified MessageEntry, so long as this MessageEntry is part of the same MessageList (else it will fail during execution of the Action).

Parameters:

me - the MessageEntry that represents the message to add

meRef - the referenced MessageEntry

Throws:

IfsException - if operation fails

(Unpublished)

removeMessage

public void removeMessage(MessageEntry me)
                   throws IfsException

Removes an existing message, prior to execution.

Parameters:

me - the MessageEntry that represents the message to remove

Throws:

IfsException - if operation fails

(Published)

editMessage

public void editMessage(MessageEntry me)
                 throws IfsException

Edits an existing message, prior to execution.

Parameters:

me - the MessageEntry that represents the message to edit

Throws:

IfsException - if operation fails

(Published)

addAttachment

public void addAttachment(Document doc)
                   throws IfsException

Adds an attachment, prior to execution.

Parameters:

doc - the Document to add as an attachment

Throws:

IfsException - if operation fails

(Published)

isMessageAdded

public boolean isMessageAdded()

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

Returns:

true if message is being added; false otherwise

(Published)

isMessageRemoved

public boolean isMessageRemoved()

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

Returns:

true if message is being removed; false otherwise

(Published)

isMessageEdited

public boolean isMessageEdited()

Returns true if this action will edit a message (when executed).

Returns:

true if message is being edited; false otherwise

(Published)

getMessage

public String getMessage()

Returns the message setting.

Returns:

the message setting

(Published)

getMessageEntryName

public String getMessageEntryName()

Returns the MessageEntry name setting.

Returns:

the MessageEntry name setting

(Published)

getMessageEntry

public MessageEntry getMessageEntry()

Returns the MessageEntry setting for edit or remove actions.

Returns:

the MessageEntry setting for edit or remove

(Published)

getReferencedMessageEntry

public MessageEntry getReferencedMessageEntry()

Returns the MessageEntry reference, for messages that are "in reply to" another MessageEntry.

Returns:

the MessageEntry setting for edit or remove

(Published)

getAttachementList

public List<Document> getAttachementList()

Returns the list of attachments for ad and edit actions

Returns:

the list of attachments for add and edit actions

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