Package org.activiti.engine.repository

Interface ProcessDefinition

  • All Known Subinterfaces:
    ProcessDefinitionEntity
    All Known Implementing Classes:
    ProcessDefinitionEntityImpl
    @Internal
public interface ProcessDefinition
    An object structure representing an executable process composed of activities and transitions. Business processes are often created with graphical editors that store the process definition in certain file format. These files can be added to a Deployment artifact, such as for example a Business Archive (.bar) file. At deploy time, the engine will then parse the process definition files to an executable instance of this class, that can be used to start a ProcessInstance.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Integer getAppVersion()  
      java.lang.String getCategory()
      category name which is derived from the targetNamespace attribute in the definitions element
      java.lang.String getDeploymentId()
      The deployment in which this process definition is contained.
      java.lang.String getDescription()
      description of this process
      java.lang.String getDiagramResourceName()
      The resource name in the deployment of the diagram image (if any).
      java.lang.String getEngineVersion()
      The engine version for this process definition (5 or 6)
      java.lang.String getId()
      unique identifier
      java.lang.String getKey()
      unique name for all versions this process definitions
      java.lang.String getName()
      label used for display purposes
      java.lang.String getResourceName()
      name of the resource of this process definition.
      java.lang.String getTenantId()
      The tenant identifier of this process definition
      int getVersion()
      version of this process definition
      boolean hasGraphicalNotation()
      Does this process definition has a graphical notation defined (such that a diagram can be generated)?
      boolean hasStartFormKey()
      Does this process definition has a start form key.
      boolean isSuspended()
      Returns true if the process definition is in suspended state.
      void setAppVersion​(java.lang.Integer appVersion)  

    • Method Detail

      • getId

        java.lang.String getId()
        unique identifier

      • getCategory

        java.lang.String getCategory()
        category name which is derived from the targetNamespace attribute in the definitions element

      • getName

        java.lang.String getName()
        label used for display purposes

      • getKey

        java.lang.String getKey()
        unique name for all versions this process definitions

      • getDescription

        java.lang.String getDescription()
        description of this process

      • getVersion

        int getVersion()
        version of this process definition

      • getResourceName

        java.lang.String getResourceName()
        name of the resource of this process definition.

      • getDeploymentId

        java.lang.String getDeploymentId()
        The deployment in which this process definition is contained.

      • getDiagramResourceName

        java.lang.String getDiagramResourceName()
        The resource name in the deployment of the diagram image (if any).

      • hasStartFormKey

        boolean hasStartFormKey()
        Does this process definition has a start form key.

      • hasGraphicalNotation

        boolean hasGraphicalNotation()
        Does this process definition has a graphical notation defined (such that a diagram can be generated)?

      • isSuspended

        boolean isSuspended()
        Returns true if the process definition is in suspended state.

      • getTenantId

        java.lang.String getTenantId()
        The tenant identifier of this process definition

      • getEngineVersion

        java.lang.String getEngineVersion()
        The engine version for this process definition (5 or 6)

      • setAppVersion

        void setAppVersion​(java.lang.Integer appVersion)

      • getAppVersion

        java.lang.Integer getAppVersion()