Package com.aquima.interactions.process

Interface IProcessEngineDefinitions

All Known Subinterfaces:
IProcessEngine
All Known Implementing Classes:
ProcessEngine, ProcessEngineDelegate, ReadonlyProcessEngine
public interface IProcessEngineDefinitions

  • Method Details

    • getCaseModel

      IMetaModel getCaseModel()
      This method returns the model that is used by the process engine to store case data.
      Returns:
      the model that is used by the process engine to store case data.

    • getRoles

      IRole[] getRoles()
      This method returns all available roles.
      Returns:
      an array containing all the roles, never null.

    • getProcessByName

      IProcessDefinition getProcessByName(String name)
      This method returns the process definition for the specified name.
      Parameters:
      name - The name of the requested process definition.
      Returns:
      The process definition for the specified name.
      Throws:
      UnknownProcessException - An unknown process exception is thrown when the supplied name does not match any process known to the process engine.

    • getTaskByName

      IProcessTaskDefinition getTaskByName(String name)
      This method returns the task definition for the specified name. When a task is loaded from the database (e.g. retrieved from the DAO), use the method getProcessTaskDefinition(GUID) instead, as that method takes renames of tasks in the current model into account. This method does not. It should therefore only be used for retrieving task definitions on task names that are loaded from the current model, such as task mappings.
      Parameters:
      name - The name of the requested process task.
      Returns:
      The process task definition for the specified name.
      Throws:
      UnknownTaskException - This exception is thrown when no task is definition matching the specified name.

    • getProcessTaskDefinition

      IProcessTaskDefinition getProcessTaskDefinition(GUID nodeId)
      This method retrieves the task definition for the specified node id. It is required that the node id corresponds to a task node. In Studio, the node id of a task node is knows as the persistency id (note that the node id is a GUID of the persistency id). This method should be used in favor of the getTaskByName(String) method whenever a task is loaded from the database (e.g. retrieved from the DAO), because it takes into account the use case that a task that is stored in the database is renamed in the current model
      Parameters:
      nodeId - the id of the task node, which is a GUID of the persistency id in Studio
      Returns:
      the process task definition for the specified node id
      Throws:
      UnknownProcessNodeException - This exception is thrown when no process node can be found for the provided node id
      ProcessNodeNotInstanceOfTaskNodeException - This exception is thrown when a node definition can be retrieved, but it does not correspond to a task node
      Since:
      13.3

    • getProcessEventByName

      IProcessEventDefinition getProcessEventByName(String eventName)
      This method returns the event definition for the specified name.
      Parameters:
      eventName - The name of the event whose definition is requested.
      Returns:
      The definition of the event with the specified name.
      Throws:
      UnknownProcessEventException - This exception is thrown when the event could not be found.

    • getMessageEventByName

      IMessageEventDefinition getMessageEventByName(String eventName)
      This method returns the message event definition for the specified name.
      Parameters:
      eventName - The name of the event whose definition is requested, may not be null.
      Returns:
      The definition of the message event with the specified name.
      Throws:
      UnknownMessageEventException - This exception is thrown when the event could not be found.

    • getNodeIds

      GUID[] getNodeIds()
      This method returns all node id.
      Returns:
      The node ids, never null.
      Since:
      9.0

    • getNodeDefinition

      IProcessNodeDefinition getNodeDefinition(GUID nodeId)
      This method returns the process node definition by the specified node id.
      Parameters:
      nodeId - The node id, may not be null
      Returns:
      The node definition, never null.
      Throws:
      UnknownProcessNodeException - When no node definition exists for the provided id.
      Since:
      9.0

    • getCaseProcesses

      IProcessDefinition[] getCaseProcesses()
      This method returns an array containing the processes that may be executed to create a new case in the process engine. The user data is used to determine the processes which may actually be executed by the provided user.
      Returns:
      Array containing the processes that may be executed to create a new case.

    • getTypeByName

      ProcessTypeDefinition getTypeByName(String typeName)

    • getAuthorizationAlgorithm

      IAuthorizationAlgorithmDefinition getAuthorizationAlgorithm(String name) throws UnknownAuthorizationAlgorithmException
      This method returns the definition of an authorization algorithm.
      Parameters:
      name - The name of the algorithm.
      Returns:
      The definition of the algorithm.
      Throws:
      UnknownAuthorizationAlgorithmException

    • getPriorityAlgorithm

      IPriorityAlgorithmDefinition getPriorityAlgorithm(String name)
      This method returns the definition of an priority algorithm.
      Parameters:
      name - The name of the algorithm.
      Returns:
      The definition of the algorithm.

    • getRoutingAlgorithm

      IRoutingAlgorithmDefinition getRoutingAlgorithm(String name)
      This method returns the routing algorithm definition for the specified name.
      Parameters:
      name - The name of the routing algorithm whose definition is requested.
      Returns:
      The definition of the routing algorithm with the specified name.
      Throws:
      UnknownRoutingAlgorithmException - This exception is thrown when the routing algorithm could not be found.

    • getExpressionParser

      IExpressionParser getExpressionParser()
      This method returns the expression parser used by the process engine.
      Returns:
      The expression parser, never null.