Package com.aquima.interactions.process

Interface IProcessDefinition

All Known Implementing Classes:
ProcessDefinition
public interface IProcessDefinition
This interface defines a process containing multiple nodes.
Since:
7.1
Author:
O. Kerpershoek

  • Method Details

    • getId

      GUID getId()
      This method returns the ID of the process.
      Returns:
      the ID of the process, may not be null.

    • getName

      String getName()
      This method returns the name of the process.
      Returns:
      the name of the process.

    • getDescription

      String getDescription()
      This method returns a description of the process.
      Returns:
      a description of the process.

    • getDisplayName

      IMultilingualText getDisplayName()
      This method returns the display name for the process.
      Returns:
      the display name for the process.

    • getTypeName

      String getTypeName()
      This method returns the name of the type of the process.
      Returns:
      the name of the type of the process.

    • getEventStartDefinitions

      IProcessEventStartDefinition[] getEventStartDefinitions()
      This method returns the definitions of how to start this process by a message event.
      Returns:
      an array of start definitions

    • getStartNode

      IProcessNodeDefinition getStartNode()
      This method returns the start node of the process. This node is used to start a subprocess or for the deprecated api call createCase
      Returns:
      the start node of the process.

    • getAdhocProcessTasks

      IProcessStepDefinition[] getAdhocProcessTasks()
      This method returns an array containing the process (tasks) that should be scheduled whenever their conditions are met. The conditions of these tasks will be checked whenever the case data changes, and the current process is still active.
      Returns:
      an array containing the process (tasks) that should be scheduled whenever their conditions are met.

    • getRoles

      IRole[] getRoles()
      This method returns an array containing the roles that are required for the process.
      Returns:
      array containing the roles that are required for the process.

    • getExitStates

      String[] getExitStates()
      This method returns all exit states of the process.
      Returns:
      The names of the exit states, never null.

    • getProcessExit

      ProcessExit getProcessExit(String exitState)
      This method returns the processexit for a certain exit state.
      Parameters:
      exitState -
      Returns:
      The exit definition for a state.