Package de.xima.fc.workflow.executor
Class FcEmailExecutor
- java.lang.Object
-
- de.xima.fc.workflow.executor.FcEmailExecutor
-
- All Implemented Interfaces:
IWorkflowActionExecutor
public final class FcEmailExecutor extends Object
Handler for executing a workflow action of typeEWorkflowNodeType.FC_EMAIL
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
Fields Modifier and Type Field Description protected IWorkflowExecutionContext
ctx
protected IWorkflowExecutionEnvironmentData
env
protected static org.slf4j.Logger
LOG
protected WorkflowNode
node
protected INodeExecutionParams<TData>
params
protected TData
props
-
Constructor Summary
Constructors Constructor Description FcEmailExecutor(INodeExecutionParams<FcEmailProps> params)
Creates a new executor for executing an email action with the given params.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Mandant
client()
protected <T> NodeThrewException
createException(TError code)
protected <T> NodeThrewException
createException(TError code, String message)
protected NodeThrewException
createException(TError code, String message, Throwable cause)
protected NodeThrewException
createException(TError code, String message, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected <T> NodeThrewException
createException(TError code, String message, Consumer<IRecordValueBuilder> errorData)
protected NodeThrewException
createException(TError code, Throwable cause)
protected NodeThrewException
createException(TError code, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected <T> NodeThrewException
createException(TError code, Consumer<IRecordValueBuilder> errorData)
protected IEntityContext
ec()
protected INormalCompletionResult
exec()
INormalCompletionResult
execute()
Executes the workflow action, and creates the result.protected Vorgang
formRecord()
protected String
getCombinedFileName(List<IResolvedFile> files, String defaultFileName, String extension)
protected Locale
locale()
protected Projekt
project()
protected void
writeToForm(IWorkflowExecutionContext ctx, Map<String,String> params, Vorgang formRecord)
Writes the specified values to the form record data, if the key from the parameter mapping has the same value as a form field in the form record data
-
-
-
Field Detail
-
LOG
protected static final org.slf4j.Logger LOG
-
ctx
protected final IWorkflowExecutionContext ctx
-
env
protected final IWorkflowExecutionEnvironmentData env
-
node
protected final WorkflowNode node
-
params
protected final INodeExecutionParams<TData> params
-
props
protected final TData props
-
-
Constructor Detail
-
FcEmailExecutor
public FcEmailExecutor(INodeExecutionParams<FcEmailProps> params)
Creates a new executor for executing an email action with the given params.- Parameters:
params
- Parameters as provided the node handler, with the environment data and the action's properties model.
-
-
Method Detail
-
exec
protected INormalCompletionResult exec() throws AbstractAbruptCompletionException
-
execute
public final INormalCompletionResult execute() throws AbstractAbruptCompletionException
Description copied from interface:IWorkflowActionExecutor
Executes the workflow action, and creates the result.- Returns:
- The success result to be returned by the post action.
- Throws:
NodeThrewException
- When the workflow action failed, as described byTError
.AbstractAbruptCompletionException
- When the action could not be completed normally for another reason (such as when it needs to return).
-
writeToForm
protected void writeToForm(IWorkflowExecutionContext ctx, Map<String,String> params, Vorgang formRecord)
Writes the specified values to the form record data, if the key from the parameter mapping has the same value as a form field in the form record data- Parameters:
ctx
- theIWorkflowExecutionContext
params
- the params that should as form record dataformRecord
- the form record
-
client
protected final Mandant client()
-
createException
protected final <T> NodeThrewException createException(TError code)
-
createException
protected final <T> NodeThrewException createException(TError code, Consumer<IRecordValueBuilder> errorData)
-
createException
protected final <T> NodeThrewException createException(TError code, String message)
-
createException
protected final <T> NodeThrewException createException(TError code, String message, Consumer<IRecordValueBuilder> errorData)
-
createException
protected final NodeThrewException createException(TError code, String message, Throwable cause)
-
createException
protected final NodeThrewException createException(TError code, String message, Throwable cause, Consumer<IRecordValueBuilder> errorData)
-
createException
protected final NodeThrewException createException(TError code, Throwable cause)
-
createException
protected final NodeThrewException createException(TError code, Throwable cause, Consumer<IRecordValueBuilder> errorData)
-
ec
protected final IEntityContext ec()
-
formRecord
protected final Vorgang formRecord()
-
getCombinedFileName
protected final String getCombinedFileName(List<IResolvedFile> files, String defaultFileName, String extension)
- Parameters:
files
- File names to combine.defaultFileName
- Default file name to use.extension
- Extension of the combined file name.- Returns:
- A file name with the given extension. When there is exactly one input file, the name of that file is taken, otherwise the default file name is used.
-
locale
protected final Locale locale()
-
project
protected final Projekt project()
-
-