Package de.xima.fc.workflow.converter.bpmn

Class FlowchartToBpmnConverterInput

java.lang.Object

de.xima.fc.workflow.converter.bpmn.FlowchartToBpmnConverterInput

public final class FlowchartToBpmnConverterInput
extends Object

Input for FlowchartToBpmnConverter that needs to be passed to the converter.

Since:

8.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowchartToBpmnConverterInput.Builder	Builder for constructing a FlowchartToBpmnConverterInput.

Method Summary

Modifier and Type	Method	Description
static FlowchartToBpmnConverterInput.Builder	builder(Mandant client, Projekt project, WorkflowProcess process, IMessageLocalizer localizer)	Creates a new FlowchartToBpmnConverterInput.Builder for constructing a FlowchartToBpmnConverterInput.
Mandant	client()	Gets the client owning the workflow process to be converted.
Clock	clock()	The clock used for getting the current time.
String	exporterName()	The name of the exporter that creates the BPMN XML file.
String	exporterVersion()	The version of the exporter that creates the BPMN XML file.
IMessageLocalizer	localizer()	Gets the localizer used during conversion for localizing messages.
WorkflowProcess	process()	Gets the process to be converted.
Projekt	project()	Gets the project containing the process to be converted.
List<WorkflowState>	states()	Gets the list of workflow states available for the process being converted.
Predicate<WorkflowTask>	taskFilter()	Gets the filter for workflow tasks.
IPresetTemporalFormatter	temporalFormatter()	The temporal formatter used for formatting date and time values in the BPMN diagram.
ZoneId	zone()	Gets the system zone ID used for date and time operations.

Methods inherited from class java.lang.Object

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

Method Detail

client

public Mandant client()

Gets the client owning the workflow process to be converted.

Returns:

The client owning the workflow process.

clock

public Clock clock()

The clock used for getting the current time.

Returns:

The clock for getting the current time.

exporterName

public String exporterName()

The name of the exporter that creates the BPMN XML file.

Returns:

The name of the exporter.

exporterVersion

public String exporterVersion()

The version of the exporter that creates the BPMN XML file.

Returns:

The version of the exporter.

localizer

public IMessageLocalizer localizer()

Gets the localizer used during conversion for localizing messages.

Returns:

The localizer used during conversion for localizing messages.

process

public WorkflowProcess process()

Gets the process to be converted.

Returns:

The process to be converted.

project

public Projekt project()

Gets the project containing the process to be converted.

Returns:

The project containing the process to be converted.

states

public List<WorkflowState> states()

Gets the list of workflow states available for the process being converted.

Returns:

The list of workflow states.

taskFilter

public Predicate<WorkflowTask> taskFilter()

Gets the filter for workflow tasks. Only tasks for which this filter returns true will be included in the converted BPMN diagram.

Returns:

The filter for workflow tasks.

temporalFormatter

public IPresetTemporalFormatter temporalFormatter()

The temporal formatter used for formatting date and time values in the BPMN diagram.

Returns:

The temporal formatter used for formatting date and time values.

zone

public ZoneId zone()

Gets the system zone ID used for date and time operations.

Returns:

The system zone ID.

builder

public static FlowchartToBpmnConverterInput.Builder builder(Mandant client,
                                                            Projekt project,
                                                            WorkflowProcess process,
                                                            IMessageLocalizer localizer)

Creates a new FlowchartToBpmnConverterInput.Builder for constructing a FlowchartToBpmnConverterInput.

Parameters:

client - The client owning the workflow process to be converted.

project - The project containing the process to be converted.

process - The process to be converted.

localizer - The localizer used during conversion for localizing messages.

Returns:

A new FlowchartToBpmnConverterInput.Builder instance.