Package de.xima.fc.workflow.executor

Class FcShowTemplateExecutor

java.lang.Object

de.xima.fc.workflow.executor.FcShowTemplateExecutor

All Implemented Interfaces:

IWorkflowActionExecutor

public final class FcShowTemplateExecutor
extends Object

Handler for executing a workflow action of type EWorkflowNodeType.FC_SHOW_TEMPLATE.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
protected final IWorkflowExecutionContext	ctx
protected final IWorkflowExecutionEnvironmentData	env
protected static final org.slf4j.Logger	LOG
protected final WorkflowNode	node
protected final INodeExecutionParams<FcShowTemplateProps>	params
protected final FcShowTemplateProps	props

Constructor Summary

Constructors

Constructor	Description
FcShowTemplateExecutor(INodeExecutionParams<FcShowTemplateProps> params)	Creates a new executor for executing a show template action with the given parameters.

Method Summary

Modifier and Type	Method	Description
protected final List<Attachment>	attachFilesToFormRecord(EFcShowTemplateError fileSystemError, EFcShowTemplateError databaseError, IAttachToFormRecordProviding attachToFormRecordProviding, File... files)
protected final List<Attachment>	attachFilesToFormRecord(EFcShowTemplateError fileSystemError, EFcShowTemplateError databaseError, File... files)	Attaches the given files to the form record.
protected final Attachment	attachFileToFormRecord(EFcShowTemplateError fileSystemError, EFcShowTemplateError databaseError, IAttachToFormRecordProviding attachToFormRecordProviding, File file)
protected final Attachment	attachFileToFormRecord(EFcShowTemplateError fileSystemError, EFcShowTemplateError databaseError, File file)	Attaches the given file to the form record.
protected final Mandant	client()
protected final <T> NodeThrewException	createException(EFcShowTemplateError code)
protected final <T> NodeThrewException	createException(EFcShowTemplateError code, String message)
protected final NodeThrewException	createException(EFcShowTemplateError code, String message, Throwable cause)
protected final NodeThrewException	createException(EFcShowTemplateError code, String message, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected final <T> NodeThrewException	createException(EFcShowTemplateError code, String message, Consumer<IRecordValueBuilder> errorData)
protected final NodeThrewException	createException(EFcShowTemplateError code, Throwable cause)
protected final NodeThrewException	createException(EFcShowTemplateError code, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected final <T> NodeThrewException	createException(EFcShowTemplateError code, Consumer<IRecordValueBuilder> errorData)
protected final NodeThrewException	createExceptionWithData(EFcShowTemplateError code, Throwable cause, Object errorData)
protected final IEntityContext	ec()
INormalCompletionResult	execute()	Executes the workflow action, and creates the result.
protected final Vorgang	formRecord()
protected final String	getCombinedFileName(List<IResolvedFile> files, String defaultFileName, String extension)
protected final Locale	locale()
protected final Projekt	project()

Methods inherited from class java.lang.Object

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

Field Details

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<FcShowTemplateProps> params

props

protected final FcShowTemplateProps props

Constructor Details

FcShowTemplateExecutor

public FcShowTemplateExecutor(INodeExecutionParams<FcShowTemplateProps> params)

Creates a new executor for executing a show template action with the given parameters.

Parameters:

params - Parameters as provided the node handler, with the environment data and the action's properties model.

Method Details

execute

public 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 by TError.

AbstractAbruptCompletionException - When the action could not be completed normally for another reason (such as when it needs to return).

attachFilesToFormRecord

protected final List<Attachment> attachFilesToFormRecord(EFcShowTemplateError fileSystemError,
 EFcShowTemplateError databaseError,
 File... files)
                                                  throws NodeThrewException

Attaches the given files to the form record.

Parameters:

fileSystemError - Error code to raise when a file could not be read from the file system.

databaseError - Error code to raise when the attachment could not be persisted in the database.

files - Files to attach.

Returns:

The newly created attachments.

Throws:

NodeThrewException - When the attachments could not be created.

attachFileToFormRecord

protected final Attachment attachFileToFormRecord(EFcShowTemplateError fileSystemError,
 EFcShowTemplateError databaseError,
 File file)
                                           throws NodeThrewException

Attaches the given file to the form record.

Parameters:

fileSystemError - Error code to raise when a file could not be read from the file system.

databaseError - Error code to raise when the attachment could not be persisted in the database.

file - File to attach.

Returns:

The newly created attachment.

Throws:

NodeThrewException - When the attachments could not be created.

attachFilesToFormRecord

protected final List<Attachment> attachFilesToFormRecord(EFcShowTemplateError fileSystemError,
 EFcShowTemplateError databaseError,
 IAttachToFormRecordProviding attachToFormRecordProviding,
 File... files)
                                                  throws NodeThrewException

Throws:

NodeThrewException

attachFileToFormRecord

protected final Attachment attachFileToFormRecord(EFcShowTemplateError fileSystemError,
 EFcShowTemplateError databaseError,
 IAttachToFormRecordProviding attachToFormRecordProviding,
 File file)
                                           throws NodeThrewException

Throws:

NodeThrewException

client

protected final Mandant client()

createException

protected final <T> NodeThrewException createException(EFcShowTemplateError code)

createException

protected final <T> NodeThrewException createException(EFcShowTemplateError code,
 Consumer<IRecordValueBuilder> errorData)

createException

protected final <T> NodeThrewException createException(EFcShowTemplateError code,
 String message)

createException

protected final <T> NodeThrewException createException(EFcShowTemplateError code,
 String message,
 Consumer<IRecordValueBuilder> errorData)

createException

protected final NodeThrewException createException(EFcShowTemplateError code,
 String message,
 Throwable cause)

createException

protected final NodeThrewException createException(EFcShowTemplateError code,
 String message,
 Throwable cause,
 Consumer<IRecordValueBuilder> errorData)

createException

protected final NodeThrewException createException(EFcShowTemplateError code,
 Throwable cause)

createException

protected final NodeThrewException createException(EFcShowTemplateError code,
 Throwable cause,
 Consumer<IRecordValueBuilder> errorData)

createExceptionWithData

protected final NodeThrewException createExceptionWithData(EFcShowTemplateError code,
 Throwable cause,
 Object 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()