Package de.uplanet.lucy.server.workflow.action

Klasse SendMailWorkflowAction

java.lang.Object

de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

de.uplanet.lucy.server.workflow.action.SendMailWorkflowAction

Alle implementierten Schnittstellen:

IActivatableWorkflowObject, ILogLevelAware, INamedWorkflowObject, INeedWorkflow, INeedWorkflowDirectory, IWorkflowAction, IWorkflowObject, Serializable

public final class SendMailWorkflowAction
extends AbstractWorkflowAction
implements INeedWorkflowDirectory, ILogLevelAware

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	SendMailWorkflowAction.AbstractRecipients
static final class	SendMailWorkflowAction.RecipientsBcc
static final class	SendMailWorkflowAction.RecipientsCc
static final class	SendMailWorkflowAction.RecipientsReplyTo
static final class	SendMailWorkflowAction.RecipientsTo
static final class	SendMailWorkflowAction.Subject	Configuration of the email subject.

Feldübersicht

Von Schnittstelle geerbte Felder de.uplanet.lucy.server.workflow.IWorkflowObject

GUID_COMPARATOR

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SendMailWorkflowAction(String p_strGuid)	Create a mail workflow action.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Map<String,String>	getHeaders()	Get the email headers.
String	getLanguage()	Get the language.
String	getLocale()	Get the locale.
MAIL_TYPE	getMailType()	Get the type of the email.
ON_ERROR_MODE	getNoRecipientErrorMode()	This property determines if an exception should be thrown if the mail has no recipients.
String	getProcessingContextSenderAddress()
SendMailWorkflowAction.RecipientsBcc	getRecipientsBcc()	Get the BCC recipients.
SendMailWorkflowAction.RecipientsCc	getRecipientsCc()	Get the CC recipients.
SendMailWorkflowAction.RecipientsReplyTo	getRecipientsReplyTo()	Get the Reply-To recipients.
SendMailWorkflowAction.RecipientsTo	getRecipientsTo()	Get the TO recipients.
String	getSenderAddress()
String	getSenderAddressDataFieldGuid()
SENDER_ADDRESS_TYPE	getSenderAddressType()
String	getSenderFallbackAddress()
SendMailWorkflowAction.Subject	getSubject()
String	getUriBody()
Path	getWorkflowDirectory()	Get the workflow directory.
boolean	isLogVerbose()	This flag determines if verbose logging is turned on or off.
WorkflowTransition	process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx)	Process a workflow event in the given context.
void	setHeaders(Map<String,String> p_headers)	Set the email headers.
void	setLanguage(String p_strLanguage)	Set the language.
void	setLocale(String p_strLocale)	Set the locale.
void	setLogVerbose(boolean p_bLogVerbose)	This flag determines if verbose logging is turned on or off.
void	setMailType(MAIL_TYPE p_mailType)	Set the type of the email.
void	setNoRecipientErrorMode(ON_ERROR_MODE p_onErrorMode)	This property determines if an exception should be thrown if the mail has no recipients.
void	setProcessingContextSenderAddress(String p_strProcessingContextSenderAddress)
void	setRecipientsBcc(SendMailWorkflowAction.RecipientsBcc p_recipientsBcc)	Set the BCC recipients.
void	setRecipientsCc(SendMailWorkflowAction.RecipientsCc p_recipientsCc)	Set the CC recipients.
void	setRecipientsReplyTo(SendMailWorkflowAction.RecipientsReplyTo p_recipientsReplyTo)	Set the Reply-To recipients.
void	setRecipientsTo(SendMailWorkflowAction.RecipientsTo p_recipientsTo)	Set the TO recipients.
void	setSenderAddress(String p_strSenderAddress)
void	setSenderAddressDataFieldGuid(String p_strSenderAddressDataFieldGuid)
void	setSenderAddressType(SENDER_ADDRESS_TYPE p_senderType)
void	setSenderFallbackAddress(String p_strSenderFallbackAddress)
void	setSubject(SendMailWorkflowAction.Subject p_subject)
void	setUriBody(String p_strUri)
void	setWorkflowDirectory(Path p_dir)	Set the workflow directory.

Von Klasse geerbte Methoden de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransition, setName, setWorkflow, toString

Von Klasse geerbte Methoden java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Konstruktordetails

SendMailWorkflowAction

public SendMailWorkflowAction(String p_strGuid)

Create a mail workflow action.

Parameter:

p_strGuid - The GUID of the action

Methodendetails

getWorkflowDirectory

public Path getWorkflowDirectory()

Beschreibung aus Schnittstelle kopiert: INeedWorkflowDirectory

Get the workflow directory.

Angegeben von:

getWorkflowDirectory in Schnittstelle INeedWorkflowDirectory

Gibt zurück:

The workflow directory.

setWorkflowDirectory

public void setWorkflowDirectory(Path p_dir)

Beschreibung aus Schnittstelle kopiert: INeedWorkflowDirectory

Set the workflow directory.

Angegeben von:

setWorkflowDirectory in Schnittstelle INeedWorkflowDirectory

Parameter:

p_dir - The workflow directory.

getRecipientsTo

public SendMailWorkflowAction.RecipientsTo getRecipientsTo()

Get the TO recipients.

Gibt zurück:

The TO recipients.

setRecipientsTo

public void setRecipientsTo(SendMailWorkflowAction.RecipientsTo p_recipientsTo)

Set the TO recipients.

Parameter:

p_recipientsTo - The TO recipients.

getRecipientsCc

public SendMailWorkflowAction.RecipientsCc getRecipientsCc()

Get the CC recipients.

Gibt zurück:

The CC recipients.

setRecipientsCc

public void setRecipientsCc(SendMailWorkflowAction.RecipientsCc p_recipientsCc)

Set the CC recipients.

Parameter:

p_recipientsCc - The CC recipients.

getRecipientsBcc

public SendMailWorkflowAction.RecipientsBcc getRecipientsBcc()

Get the BCC recipients.

Gibt zurück:

The BCC recipients.

setRecipientsBcc

public void setRecipientsBcc(SendMailWorkflowAction.RecipientsBcc p_recipientsBcc)

Set the BCC recipients.

Parameter:

p_recipientsBcc - The BCC recipients.

getRecipientsReplyTo

public SendMailWorkflowAction.RecipientsReplyTo getRecipientsReplyTo()

Get the Reply-To recipients.

Gibt zurück:

The Reply-To recipients.

setRecipientsReplyTo

public void setRecipientsReplyTo(SendMailWorkflowAction.RecipientsReplyTo p_recipientsReplyTo)

Set the Reply-To recipients.

Parameter:

p_recipientsReplyTo - The Reply-To recipients.

getNoRecipientErrorMode

public ON_ERROR_MODE getNoRecipientErrorMode()

This property determines if an exception should be thrown if the mail has no recipients.

Gibt zurück:

The error handling mode.

setNoRecipientErrorMode

public void setNoRecipientErrorMode(ON_ERROR_MODE p_onErrorMode)

This property determines if an exception should be thrown if the mail has no recipients.

Parameter:

p_onErrorMode - The error mode to be used. May be either ON_ERROR_MODE.THROW_EXCEPTION, or ON_ERROR_MODE.NO_ACTION.

getHeaders

public Map<String,String> getHeaders()

Get the email headers.

Gibt zurück:

The email headers.

isLogVerbose

public boolean isLogVerbose()

Beschreibung aus Schnittstelle kopiert: ILogLevelAware

This flag determines if verbose logging is turned on or off.

Angegeben von:

isLogVerbose in Schnittstelle ILogLevelAware

Gibt zurück:

true if logging is verbose, or false otherwise.

setLogVerbose

public void setLogVerbose(boolean p_bLogVerbose)

Beschreibung aus Schnittstelle kopiert: ILogLevelAware

This flag determines if verbose logging is turned on or off.

Angegeben von:

setLogVerbose in Schnittstelle ILogLevelAware

Parameter:

p_bLogVerbose - true if logging should be verbose, or false otherwise.

setHeaders

public void setHeaders(Map<String,String> p_headers)

Set the email headers.

Parameter:

p_headers - The email headers.

getMailType

public MAIL_TYPE getMailType()

Get the type of the email.

Gibt zurück:

Type of the email.

setMailType

public void setMailType(MAIL_TYPE p_mailType)

Set the type of the email.

Parameter:

p_mailType - The type of the email.

getLanguage

public String getLanguage()

Get the language.

This value can either be a language identifier, or a known context name.

If this value is not set, the ContextLanguage will be used.

Gibt zurück:

The language, or null if the default language is being used.

Siehe auch:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

setLanguage

public void setLanguage(String p_strLanguage)

Set the language.

This value can either be a language identifier, or a known context name.

If this value is not set, the ContextLanguage will be used.

Siehe auch:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

getLocale

public String getLocale()

Get the locale.

This value can either be a locale identifier, or a known context name.

If this value is not set, the ContextLocale will be used.

Gibt zurück:

The locale, or null if the default locale is being used.

Siehe auch:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

setLocale

public void setLocale(String p_strLocale)

Set the locale.

This value can either be a locale identifier, or a known context name.

If this value is not set, the ContextLanguage will be used.

Siehe auch:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

getSubject

public SendMailWorkflowAction.Subject getSubject()

setSubject

public void setSubject(SendMailWorkflowAction.Subject p_subject)

getUriBody

public String getUriBody()

setUriBody

public void setUriBody(String p_strUri)

getSenderAddressType

public SENDER_ADDRESS_TYPE getSenderAddressType()

setSenderAddressType

public void setSenderAddressType(SENDER_ADDRESS_TYPE p_senderType)

getSenderAddress

public String getSenderAddress()

setSenderAddress

public void setSenderAddress(String p_strSenderAddress)

getProcessingContextSenderAddress

public String getProcessingContextSenderAddress()

setProcessingContextSenderAddress

public void setProcessingContextSenderAddress(String p_strProcessingContextSenderAddress)

getSenderAddressDataFieldGuid

public String getSenderAddressDataFieldGuid()

setSenderAddressDataFieldGuid

public void setSenderAddressDataFieldGuid(String p_strSenderAddressDataFieldGuid)

getSenderFallbackAddress

public String getSenderFallbackAddress()

setSenderFallbackAddress

public void setSenderFallbackAddress(String p_strSenderFallbackAddress)

process

public WorkflowTransition process(IWorkflowEvent p_evt,
 de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx,
 de.uplanet.lucy.server.IProcessingContext p_ctx)
                           throws Exception

Beschreibung aus Schnittstelle kopiert: IWorkflowAction

Process a workflow event in the given context.

Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

Angegeben von:

process in Schnittstelle IWorkflowAction

Parameter:

p_evt - The event to be processed.

p_wfCtx - The workflow processing context.

p_ctx - The processing context.

Gibt zurück:

The efferent transition, or null.

Löst aus:

Exception - If an error occurred.