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 workflow action (EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE).

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

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
MultiFile	getAttachments()	Gets the attachments to send with the message.
String	getEmail()	The email address to send the message to, if the message could not be delivered via a message service.
String	getMessageContent()	Gets the content of the message to create.
FormRecordChatUser	getReceiver()	The user who should receive the message.
String	getSenderName()	The name of the sender of the message.
String	getSubject()	The subject of the message to create.
FcSendFormRecordMessageUploadRequestProps	getUploadRequest()
boolean	isOpenChat()	When a new chat is created: Whether the chat should be kept open.
boolean	isSendUploadRequest()
void	setAttachments(MultiFile attachments)	Sets the attachments to send with the message.
void	setEmail(String email)	The email address to send the message to, if the message could not be delivered via a message service.
void	setMessageContent(String messageContent)	Sets the content of the message to create.
void	setOpenChat(boolean openChat)	When a new chat is created: Whether the chat should be kept open.
void	setReceiver(FormRecordChatUser receiver)	The user who should receive the message.
void	setSenderName(String senderName)	The name of the sender of the message.
void	setSendUploadRequest(boolean sendUploadRequest)
void	setSubject(String subject)	The subject of the message to create.
void	setUploadRequest(FcSendFormRecordMessageUploadRequestProps uploadRequest)

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

getAttachments

public MultiFile getAttachments()

Gets the attachments to send with the message.

Returns:

The attachments.

setAttachments

public void setAttachments(MultiFile attachments)

Sets the attachments to send with the message.

Parameters:

attachments - The attachments.

getEmail

public String getEmail()

The email address to send the message to, if the message could not be delivered via a message service.

Returns:

The email address.

setEmail

public void setEmail(String email)

The email address to send the message to, if the message could not be delivered via a message service.

Parameters:

email - The email address.

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.

getReceiver

public FormRecordChatUser getReceiver()

The user who should receive the message. May contain placeholders.

Returns:

The receiver of the message.

setReceiver

public void setReceiver(FormRecordChatUser receiver)

The user who should receive the message. May contain placeholders.

Parameters:

receiver - The receiver of the message.

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.

getSubject

public String getSubject()

The subject of the message to create. May contain placeholders.

Returns:

The message subject.

setSubject

public void setSubject(String subject)

The subject of the message to create. May contain placeholders.

Parameters:

subject - The message subject.

getUploadRequest

public FcSendFormRecordMessageUploadRequestProps getUploadRequest()

setUploadRequest

public void setUploadRequest(FcSendFormRecordMessageUploadRequestProps uploadRequest)

isOpenChat

public boolean isOpenChat()

When a new chat is created: Whether the chat should be kept open. 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)

When a new chat is created: Whether the chat should be kept open. 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.

isSendUploadRequest

public boolean isSendUploadRequest()

setSendUploadRequest

public void setSendUploadRequest(boolean sendUploadRequest)