Package org.flowable.common.engine.api.repository

Interface FlowableDefinition

All Known Subinterfaces:
AppDefinition, CaseDefinition, CaseDefinitionEntity, ChannelDefinition, ChannelDefinitionEntity, DecisionEntity, DmnDecision, EventDefinition, EventDefinitionEntity, FormDefinition, ProcessDefinition, ProcessDefinitionEntity
All Known Implementing Classes:
CaseDefinitionEntityImpl, ChannelDefinitionEntityImpl, DecisionEntityImpl, EventDefinitionEntityImpl, ProcessDefinitionEntityImpl
public interface FlowableDefinition
Common interface for all engine definitions (process, case, decision, app, form, event and channel definitions).

A definition is a versioned, deployable artifact contained in an EngineDeployment. This interface exposes only the properties that are common to and mandatory for every definition type, so that consumers can handle any definition uniformly regardless of the owning engine. Engine-specific properties (such as category or description) remain on the concrete definition interfaces.

  • Method Details

    • getId

      String getId()
      unique identifier

    • getKey

      String getKey()
      unique key, stable across all versions of this definition

    • getName

      String getName()
      label used for display purposes

    • getVersion

      int getVersion()
      version of this definition

    • getResourceName

      String getResourceName()
      name of the resource of this definition within its deployment

    • getDeploymentId

      String getDeploymentId()
      the deployment in which this definition is contained

    • getTenantId

      String getTenantId()
      the tenant identifier of this definition