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
Modifier and TypeInterfaceDescriptionstatic enum
Process element types defined for 3rd party elements. -
Method Summary
Modifier and TypeMethodDescriptiondefault String
default String
Class<? extends IUserProcessExtension>
Specifies an executor class.default String
default IBpmnProcessElement.ElementKind
getKind()
Specifies the type of 3rd party process element is implemented.default String
getLabel()
getName()
Returns the name of the 3rd party process element.default EnumSet<ch.ivyteam.ivy.process.model.ProcessKind>
Specifies the process kinds in which the process element class entry is allowed.default String
default Class<? extends ch.ivyteam.ivy.process.validate.ElementValidator>
Specifies the process element validator class of this process element.
-
Method Details
-
getExecutor
Class<? extends IUserProcessExtension> getExecutor()Specifies an executor class. Its methodperform()
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
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
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
Specifies the type of 3rd party process element is implemented. SeeIBpmnProcessElement.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.
-
getIconId
- Since:
- 9.4.0
- API:
- This public API is available in Java.
-
getShortLabel
- Since:
- 9.4.0
- API:
- This public API is available in Java.
-
getLabel
- Since:
- 9.4.0
- API:
- This public API is available in Java.
-
getDescription
- Since:
- 9.4.0
- API:
- This public API is available in Java.
-
getElementGroup
- Since:
- 9.4.0
- API:
- This public API is available in Java.
-