Package de.xima.fc.workflow.model.nodes

Class FcSendFormRecordMessageProps

java.lang.Object

de.xima.fc.workflow.taglib.model.BaseActionProps

de.xima.fc.workflow.model.nodes.FcSendFormRecordMessageProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, Serializable

public final class FcSendFormRecordMessageProps
extends BaseActionProps
implements Serializable

Model class for the log entry action (EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE).

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FcSendFormRecordMessageProps.ValidationGroup	Validation group sequence provider for the FcSendFormRecordMessageProps class.

Nested classes/interfaces inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

BaseActionProps.name

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
FcSendFormRecordMessageProps()

Method Summary

Modifier and Type	Method	Description
String	getMessageContent()	Gets the content of the message to create.
String	getSenderName()	The name of the sender of the message.
ESendFormRecordMessageTargetChatType	getTargetChatType()	How to determine the chat to which the message will be sent.
String	getTargetChatUuid()	When the target chat type is set to EXISTING_CHAT: the UUID of an existing chat to use for sending the message.
ESendFormRecordMessageTargetMemberType	getTargetMemberType()	The workflow action creates a new chat for the message.
boolean	isOpenChat()	Gets whether the chat should be opened after the message has been created.
void	setMessageContent(String messageContent)	Sets the content of the message to create.
void	setOpenChat(boolean openChat)	Set whether the chat should be opened after the message has been created.
void	setSenderName(String senderName)	The name of the sender of the message.
void	setTargetChatType(ESendFormRecordMessageTargetChatType targetChatType)	How to determine the chat to which the message will be sent.
void	setTargetChatUuid(String targetChatUuid)	When the target chat type is set to EXISTING_CHAT: the UUID of an existing chat to use for sending the message.
void	setTargetMemberType(ESendFormRecordMessageTargetMemberType targetMemberType)	The workflow action creates a new chat for the message.

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FcSendFormRecordMessageProps

public FcSendFormRecordMessageProps()

Method Detail

getMessageContent

public String getMessageContent()

Gets the content of the message to create. May contain placeholders.

Returns:

The message content.

setMessageContent

public void setMessageContent(String messageContent)

Sets the content of the message to create. May contain placeholders.

Parameters:

messageContent - The message content.

getSenderName

public String getSenderName()

The name of the sender of the message. The actual user who sent the message will always be set to the system user. However, the sender name can be set to any arbitrary value. May contain placeholders.

Returns:

The sender name.

setSenderName

public void setSenderName(String senderName)

The name of the sender of the message. The actual user who sent the message will always be set to the system user. However, the sender name can be set to any arbitrary value. May contain placeholders.

Parameters:

senderName - The sender name.

getTargetChatType

public ESendFormRecordMessageTargetChatType getTargetChatType()

How to determine the chat to which the message will be sent. Either creates a new chat or uses an existing one. For a new chat, the recipient needs to be specified. For an existing chat, it needs to be identified by its UUID.

Returns:

The target chat type.

setTargetChatType

public void setTargetChatType(ESendFormRecordMessageTargetChatType targetChatType)

How to determine the chat to which the message will be sent. Either creates a new chat or uses an existing one. For a new chat, the recipient needs to be specified. For an existing chat, it needs to be identified by its UUID.

Parameters:

targetChatType - The target chat type.

getTargetChatUuid

public String getTargetChatUuid()

When the target chat type is set to EXISTING_CHAT: the UUID of an existing chat to use for sending the message. May contain placeholders, and even should contain placeholders, as the UUID is not known at design time.

Returns:

The UUID of the target chat.

setTargetChatUuid

public void setTargetChatUuid(String targetChatUuid)

When the target chat type is set to EXISTING_CHAT: the UUID of an existing chat to use for sending the message. May contain placeholders, and even should contain placeholders, as the UUID is not known at design time.

Parameters:

targetChatUuid - The UUID of the target chat.

getTargetMemberType

public ESendFormRecordMessageTargetMemberType getTargetMemberType()

The workflow action creates a new chat for the message. This property controls the members of the newly created chat. When the member is anonymous or the system user, the action raises an error.

Returns:

The target member type.

setTargetMemberType

public void setTargetMemberType(ESendFormRecordMessageTargetMemberType targetMemberType)

The workflow action creates a new chat for the message. This property controls the members of the newly created chat. When the member is anonymous or the system user, the action raises an error.

Parameters:

targetMemberType - The target member type.

isOpenChat

public boolean isOpenChat()

Gets whether the chat should be opened after the message has been created. When enabled, the end user can send replies. When disabled, the end user cannot send replies (but an inbox agent can still send messages to the end user).

Returns:

Whether the chat should be opened after the message has been created.

setOpenChat

public void setOpenChat(boolean openChat)

Set whether the chat should be opened after the message has been created. When enabled, the end user can send replies. When disabled, the end user cannot send replies (but an inbox agent can still send messages to the end user).

Parameters:

openChat - Whether the chat should be opened after the message has been created.