Package de.xima.fc.interfaces.workflow.bpmn

Interface IWorkflowNodeBpmnModeler<Model>

Type Parameters:

Model - Type of the properties model for the node. Use JSONObject if you want to get the raw data and possibly perform serialization / deserialization yourself. See getDataModelClass.

All Known Implementing Classes:

ABinarySelectionBpmnModeler, APostTestLoopBpmnModeler, APreTestLoopBpmnModeler, AServiceTaskBpmnModeler, FcBreakBpmnModeler, FcChangeFormAvailabilityBpmnModeler, FcChangeFormRecordChatActivenessBpmnModeler, FcChangeFormValueBpmnModeler, FcChangeStateBpmnModeler, FcCompressAsZipBpmnModeler, FcContinueBpmnModeler, FcCopyFormRecordBpmnModeler, FcCounterBpmnModeler, FcCreateTextFileBpmnModeler, FcDecodeBase64BpmnModeler, FcDeleteAttachmentBpmnModeler, FcDeleteFormRecordBpmnModeler, FcDoiInitBpmnModeler, FcDoUntilLoopBpmnModeler, FcEmailBpmnModeler, FcEmptyBpmnModeler, FcEncodeBase64BpmnModeler, FcExperimentBpmnModeler, FcExportFormRecordChatsBpmnModeler, FcExportToPersistenceBpmnModeler, FcExportToXmlBpmnModeler, FcFillPdfBpmnModeler, FcFillWordBpmnModeler, FcForEachLoopBpmnModeler, FcHttpRequestBpmnModeler, FcImportFormValueFromXmlBpmnModeler, FcLdapQueryBpmnModeler, FcLogEntryBpmnModeler, FcMoveFormRecordToInboxBpmnModeler, FcMultipleConditionBpmnModeler, FcProcessLogPdfBpmnModeler, FcProvideResourceBpmnModeler, FcQueueTaskBpmnModeler, FcRedirectBpmnModeler, FcRenewProcessIdBpmnModeler, FcReturnBpmnModeler, FcReturnFileBpmnModeler, FcSaveToFileSystemBpmnModeler, FcSaveToWebDavBpmnModeler, FcSendFormRecordMessageBpmnModeler, FcSequenceBpmnModeler, FcSetSavedFlagBpmnModeler, FcShowTemplateBpmnModeler, FcSqlStatementBpmnModeler, FcSwitchBpmnModeler, FcSwitchCaseBpmnModeler, FcSwitchDefaultBpmnModeler, FcThrowExceptionBpmnModeler, FcVoidBpmnModeler, FcWhileLoopBpmnModeler, FcWriteFormRecordAttrBpmnModeler

public interface IWorkflowNodeBpmnModeler<Model>

Interface for modeling workflow nodes in a BPMN 2.0 diagram. Used to create a BPMN diagram of the entire workflow.

The modeler does not need to have any state and can be immutable. The modeler must be thread-safe.

Since:

8.4.0

Author:

XIMA MEDIA GmbH

See Also:

INodeHandler.getBpmnModeler()

Method Summary

Modifier and Type	Method	Description
void	modelNode(IModelWorkflowNodeParams<Model> params, IWorkflowBpmnModelContext context)	Models a WorkflowNode in the BPMN diagram.

Method Detail

modelNode

void modelNode(IModelWorkflowNodeParams<Model> params,
               IWorkflowBpmnModelContext context)

Models a WorkflowNode in the BPMN diagram. This method is called once for the root node of each WorkflowTask in the workflow. Implementations for nodes that have children should call context.modelNode(node) on their child nodes if needed.

The responsibility of each modeler is to access the provided params.partBuilder() and add the appropriate data to that builder. That data then gets used to create a IStructuredBpmnModelPart for the node, see the class-level documentation of IStructuredBpmnModelPart for more info.

When modelling a workflow node as BPMN, the usual approach is to create a nested tree of alignment items, making use of the layouter. This tree then gets resolved to a flat map. Finally, the various method on IFlattenedAlignmentItemMap can be used to create the BPMN shapes, BPMN edges and sequence flows.

Parameters:

params - The parameters for the modeler, containing the WorkflowNode to model and its deserialized custom properties model, as well as the part builder to fill with data.

context - The context for creating the BPMN diagram, its lifecycle starts when the conversion (of the workflow to a BPMN diagram) starts and ends when the conversion ends. The context lets you access various helper methods such as the layouter() or colorizer, and also provides access to all global data such as all triggers and nodes in the workflow.