Package de.xima.fc.workflow.model.nodes
Class FcDoiInitProps
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.BaseActionProps
-
- de.xima.fc.workflow.model.nodes.FcDoiInitProps
-
- All Implemented Interfaces:
IDescriptionProviding
,INameProviding
,Serializable
@NotEmptyIf(field="body",dependants="bodyFormatType",target=FcDoiInitProps.class) @NotEmptyIf(field="plainBody",dependants="bodyFormatType",target=FcDoiInitProps.class) public final class FcDoiInitProps extends BaseActionProps implements Serializable
Model class for the workflow action that initializes the Double-Opt-In process.- Since:
- 7.0.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 Modifier and Type Field Description static String
SEARCH_TERM_TARGET_UUID
Key for storing the UUID of the selected HTML-Template for DoI verification failures as aWorkflowNodeSearchTerm
-
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 FcDoiInitProps()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBody()
EEmailBodyFormatType
getBodyFormatType()
UuidEntityRef
getDoiFailTemplate()
String
getFrom()
String
getPlainBody()
String
getSenderName()
String
getSubject()
List<String>
getTo()
boolean
isActivateVerifyPage()
boolean
isLockFormRecord()
void
setActivateVerifyPage(boolean activateVerifyPage)
void
setBody(String body)
void
setBodyFormatType(EEmailBodyFormatType bodyFormatType)
void
setDoiFailTemplate(UuidEntityRef doiFailTemplate)
void
setFrom(String from)
void
setLockFormRecord(boolean lockFormRecord)
void
setPlainBody(String plainBody)
void
setSenderName(String senderName)
void
setSubject(String subject)
void
setTo(List<String> to)
String
toString()
-
Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName
-
-
-
-
Field Detail
-
SEARCH_TERM_TARGET_UUID
public static final String SEARCH_TERM_TARGET_UUID
Key for storing the UUID of the selected HTML-Template for DoI verification failures as aWorkflowNodeSearchTerm
- See Also:
- Constant Field Values
-
-
Method Detail
-
getBody
public String getBody()
- Returns:
- When the
body type
is set toboth
orEEmailBodyFormatType.HTML
, the HTML content of the email.
-
getBodyFormatType
public EEmailBodyFormatType getBodyFormatType()
- Returns:
- Content type of the email body, i.e. whether to send the email as HTML, as plain text, or both.
-
getDoiFailTemplate
public UuidEntityRef getDoiFailTemplate()
-
getFrom
public String getFrom()
- Returns:
- The email address from which the mail was sent, used for the FROM header.
-
getPlainBody
public String getPlainBody()
- Returns:
- When the
body type
is set toboth
orEEmailBodyFormatType.PLAIN_TEXT
, the plain text content of the email.
-
getSenderName
public String getSenderName()
- Returns:
- Optional name of the sender. When given, this name is included in the FROM header.
-
getSubject
public String getSubject()
- Returns:
- The subject line of the email, i.e. the heading or title.
-
isActivateVerifyPage
public boolean isActivateVerifyPage()
- Returns:
- Controls the behavior when the user clicks on the verification link. When
false
, the double opt-in is verified immediately. Whenfalse
, a page with a verification button is shown.
-
isLockFormRecord
public boolean isLockFormRecord()
- Returns:
- Whether the form record should be locked when while waiting for the double opt-in process to be completed.
- Since:
- 8.0.0
-
setActivateVerifyPage
public void setActivateVerifyPage(boolean activateVerifyPage)
- Parameters:
activateVerifyPage
- Controls the behavior when the user clicks on the verification link. Whenfalse
, the double opt-in is verified immediately. Whenfalse
, a page with a verification button is shown.
-
setBody
public void setBody(String body)
- Parameters:
body
- When thebody type
is set toboth
orEEmailBodyFormatType.HTML
, the HTML content of the email.
-
setBodyFormatType
public void setBodyFormatType(EEmailBodyFormatType bodyFormatType)
- Parameters:
bodyFormatType
- Content type of the email body, i.e. whether to send the email as HTML, as plain text, or both.
-
setDoiFailTemplate
public void setDoiFailTemplate(UuidEntityRef doiFailTemplate)
-
setFrom
public void setFrom(String from)
- Parameters:
from
- The email address from which the mail was sent, used for the FROM header.
-
setLockFormRecord
public void setLockFormRecord(boolean lockFormRecord)
- Parameters:
lockFormRecord
- Whether the form record should be locked when while waiting for the double opt-in process to be completed.- Since:
- 8.0.0
-
setPlainBody
public void setPlainBody(String plainBody)
- Parameters:
plainBody
- When thebody type
is set toboth
orEEmailBodyFormatType.PLAIN_TEXT
, the plain text content of the email.
-
setSenderName
public void setSenderName(String senderName)
- Parameters:
senderName
- Optional name of the sender. When given, this name is included in the FROM header.
-
setSubject
public void setSubject(String subject)
- Parameters:
subject
- The subject line of the email, i.e. the heading or title.
-
setTo
public void setTo(List<String> to)
- Parameters:
to
- List of email addresses to which to send the email.
-
-