Package ch.ivyteam.ivy.bpm.exec

Interface IBpmnProcessElement

public interface IBpmnProcessElement

Extension point interface to provide the execution part of an 3rd party Ivy process element.

3rd party providers can implement this interface to provide an ivy extension for defining their own process elements based on the process elements:

• Program Interface
• Start Event
• Intermediate Event
• Call & Wait

Since:

9.2.0

API:

This is a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IBpmnProcessElement.ElementKind	Process element types defined for 3rd party elements.

Method Summary

Modifier and Type	Method	Description
Class<? extends IUserProcessExtension>	getExecutor()	Specifies an executor class.
default IBpmnProcessElement.ElementKind	getKind()	Specifies the type of 3rd party process element is implemented.
String	getName()	Returns the name of the 3rd party process element.
default EnumSet<ch.ivyteam.ivy.components.ProcessKind>	getProcessKinds()	Specifies the process kinds in which the process element class entry is allowed.
default Class<? extends ch.ivyteam.ivy.process.validate.ElementValidator>	getValidator()	Specifies the process element validator class of this process element.

Method Detail

getExecutor

Class<? extends IUserProcessExtension> getExecutor()

Specifies an executor class. Its method perform() will be run during execution.

Returns:

The executor class used for this 3rd party process element.

Since:

9.2.0

API:

This public API is available in Java.

getName

String getName()

Returns the name of the 3rd party process element.

Returns:

The name of this process element.

Since:

9.2.0

API:

This public API is available in Java.

getValidator

default Class<? extends ch.ivyteam.ivy.process.validate.ElementValidator> getValidator()

Specifies the process element validator class of this process element.

The implementation of this method is optional. The default implementation does not specify a validator.

Returns:

The element validator class or null.

Since:

9.2.0

API:

This public API is available in Java.

getProcessKinds

default EnumSet<ch.ivyteam.ivy.components.ProcessKind> getProcessKinds()

Specifies the process kinds in which the process element class entry is allowed.

The implementation of this method is optional. The default implementation allows the process element in all process kinds.

Returns:

A set of process kinds the process element is allowed in.

Since:

9.2.0

API:

This public API is available in Java.

getKind

default IBpmnProcessElement.ElementKind getKind()

Specifies the type of 3rd party process element is implemented. See IBpmnProcessElement.ElementKind about what types are defined.^

Returns:

The type of this process element.

Since:

9.2.0

API:

This public API is available in Java.