public class CommentAction extends MessageAction
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_COMMENT_ADDED
The AuditEventTypeDefinition for the COMMENT_ADDED action.
|
static AuditEventTypeDefinition |
EVENTTYPE_COMMENT_EDITED
The AuditEventTypeDefinition for the COMMENT_EDITED action.
|
static AuditEventTypeDefinition |
EVENTTYPE_COMMENT_REMOVED
The AuditEventTypeDefinition for the COMMENT_REMOVED action.
|
EVENTTYPE_MESSAGE_ADDED, EVENTTYPE_MESSAGE_EDITED, EVENTTYPE_MESSAGE_REMOVED
Constructor and Description |
---|
CommentAction()
Constructs a CommentAction to be used as an ActionFactory.
|
CommentAction(ActionFactory factory)
Constructs a "pending" CommentAction, to be used to execute a new Action.
|
CommentAction(ActionFactory factory,
AuditEvent event)
Constructs an "executed" CommentAction, reflecting a previously
executed Action.
|
Modifier and Type | Method and Description |
---|---|
void |
addComment(MessageEntry me)
Adds a new comment, prior to execution.
|
void |
addComment(MessageEntry me,
MessageEntry meRef)
Adds a new comment, 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.
|
void |
editComment(MessageEntry me)
Edits an existing comment, prior to execution.
|
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 |
getComment()
Returns the comment setting.
|
boolean |
isCommentAdded()
Returns true if this action will add a comment (when executed).
|
boolean |
isCommentEdited()
Returns true if this action will edit a comment (when executed).
|
boolean |
isCommentRemoved()
Returns true if this action will remove a comment (when executed).
|
void |
removeComment(MessageEntry me)
Removes an existing comment, prior to execution.
|
addAttachment, addMessage, addMessage, clearAllSettings, editMessage, execute, getAttachementList, getMessage, getMessageEntry, getMessageEntryName, getReferencedMessageEntry, isMessageAdded, isMessageEdited, isMessageRemoved, removeMessage
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
constructActivityEventTypeDefinition, initialize, isInitialized
public static final String DEFAULT_ACTIONSPECIFICATION_NAME
public static final AuditEventTypeDefinition EVENTTYPE_COMMENT_ADDED
public static final AuditEventTypeDefinition EVENTTYPE_COMMENT_EDITED
public static final AuditEventTypeDefinition EVENTTYPE_COMMENT_REMOVED
public CommentAction()
Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
public CommentAction(ActionFactory factory) throws IfsException
factory
- the ActionFactory used to construct this instanceIfsException
- if operation failspublic CommentAction(ActionFactory factory, AuditEvent event) throws IfsException
factory
- the ActionFactory used to construct this instanceevent
- The event that was posted as part of the
previously executed Action.IfsException
- if operation failspublic Action constructPendingAction() throws IfsException
constructPendingAction
in class MessageAction
IfsException
- if the operation fails.public Action constructExecutedAction(AuditEvent event) throws IfsException
constructExecutedAction
in class MessageAction
event
- The event that was posted as part of the
previously executed Action.IfsException
- if the operation fails.public void addComment(MessageEntry me) throws IfsException
me
- the MessageEntry that represents the comment to addIfsException
- if operation failspublic void addComment(MessageEntry me, MessageEntry meRef) throws IfsException
me
- the MessageEntry that represents the comment to addmeRef
- the referenced MessageEntryIfsException
- if operation failspublic void removeComment(MessageEntry me) throws IfsException
me
- the MessageEntry that represents the comment to removeIfsException
- if operation failspublic void editComment(MessageEntry me) throws IfsException
me
- the MessageEntry that represents the comment editedIfsException
- if operation failspublic boolean isCommentAdded()
public boolean isCommentRemoved()
public boolean isCommentEdited()
public String getComment()
public AuditEventTypeDefinition[] getAuditEventTypeDefinitions()
getAuditEventTypeDefinitions
in class MessageAction
public AuditEventTypeDefinition getAuditEventTypeDefinitionForAdd()
getAuditEventTypeDefinitionForAdd
in class MessageAction
public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()
getAuditEventTypeDefinitionForRemove
in class MessageAction
public AuditEventTypeDefinition getAuditEventTypeDefinitionForEdit()
getAuditEventTypeDefinitionForEdit
in class MessageAction
Copyright © 2023. All rights reserved.