Class FcWhileLoopExecutor

java.lang.Object

de.xima.fc.workflow.executor.FcWhileLoopExecutor

All Implemented Interfaces:

IWorkflowActionExecutor

public final class FcWhileLoopExecutor
extends Object

Handler for executing a workflow node of type EWorkflowNodeType.FC_WHILE_LOOP.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHILD_LOOP_BODY	The child that represents the body of the loop.
protected final IWorkflowExecutionContext	ctx
protected final IWorkflowExecutionEnvironmentData	env
protected static final org.slf4j.Logger	LOG
protected final WorkflowNode	node
protected final INodeExecutionParams<FcWhileLoopProps>	params
protected final FcWhileLoopProps	props

Constructor Summary

Constructors

Constructor	Description
FcWhileLoopExecutor(INodeExecutionParams<FcWhileLoopProps> params)	Creates a new executor for executing a while loop node with the given params.

Method Summary

Modifier and Type	Method	Description
protected final void	addSoftError(EFcWhileLoopSoftError code, String message, Throwable cause)
protected final Mandant	client()
protected final NodeThrewException	createException(EFcWhileLoopError code)
protected final NodeThrewException	createException(EFcWhileLoopError code, String message)
protected final NodeThrewException	createException(EFcWhileLoopError code, String message, Throwable cause)
protected final NodeThrewException	createException(EFcWhileLoopError code, String message, Throwable cause, Object value)
protected final NodeThrewException	createException(EFcWhileLoopError code, String message, Throwable cause, Consumer<IRecordValueBuilder> errorData)
protected final NodeThrewException	createException(EFcWhileLoopError code, String message, Consumer<IRecordValueBuilder> errorData)
protected final NodeThrewException	createException(EFcWhileLoopError code, Throwable cause)
protected final NodeThrewException	createException(EFcWhileLoopError code, Throwable cause, Object value)
protected final NodeThrewException	createExceptionWithData(EFcWhileLoopError 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 Object

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

Field Details

CHILD_LOOP_BODY

public static final int CHILD_LOOP_BODY

The child that represents the body of the loop.

See Also:

• Constant Field Values

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

props

protected final FcWhileLoopProps props

Constructor Details

FcWhileLoopExecutor

public FcWhileLoopExecutor(INodeExecutionParams<FcWhileLoopProps> params)

Creates a new executor for executing a while loop node with the given params.

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:

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

addSoftError

protected final void addSoftError(EFcWhileLoopSoftError code,
 String message,
 Throwable cause)

client

protected final Mandant client()

createException

protected final NodeThrewException createException(EFcWhileLoopError code)

createException

protected final NodeThrewException createException(EFcWhileLoopError code,
 String message)

createException

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

createException

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

createException

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

createException

protected final NodeThrewException createException(EFcWhileLoopError code,
 Throwable cause)

createException

protected final NodeThrewException createException(EFcWhileLoopError code,
 Throwable cause,
 Object value)

createException

protected final NodeThrewException createException(EFcWhileLoopError code,
 String message,
 Throwable cause,
 Object value)

createExceptionWithData

protected final NodeThrewException createExceptionWithData(EFcWhileLoopError 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()