Package com.aquima.interactions.process.ds

Interface IProcessFlowDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlProcessFlowDS, XmlProcessFlowDS
public interface IProcessFlowDS extends IReportingDS
This interface is used to initialize a single process flow.
Since:
7.0
Author:
O. Kerpershoek

  • Method Details

    • getId

      GUID getId()
      This method returns the id of the process flow.
      Returns:
      the id of the process flow, never null.

    • getName

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

    • 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 process type.
      Returns:
      the name of the process type.

    • getRoles

      String[] getRoles()
      This method returns an array containing the names of the roles a user should have in order to be allowed to start a process. The roles are only relevant for top-level process definitions. If this method does not return any roles, any user is allowed to start the process.
      Returns:
      an array containing the names of the roles a user should have in order to be allowed to start a process.

    • getStartNodeId

      GUID getStartNodeId()
      This method returns the ID of the start node.
      Returns:
      The ID of the start node.

    • iterateNodes

      void iterateNodes(IProcessNodeVisitor visitor)
      This method should iterate over all the nodes of the process flow, and add a data source to the visitor for each one.
      Parameters:
      visitor - The visitor that should be used to add the nodes to.
      Throws:
      InitializationException - This exception is thrown if the nodes could not be initialized.

    • iterateEdges

      void iterateEdges(IProcessEdgeVisitor visitor)
      This method should iterate over all the edges of the process flow, and add a data source to the visitor for each one.
      Parameters:
      visitor - The visitor that should be used to add the edges to.
      Throws:
      InitializationException - This exception is thrown if the edges could not be initialized.

    • iterateEventStartDefinitions

      void iterateEventStartDefinitions(IProcessEventStartVisitor visitor)
      This method should iterate about all the event start definitions of the process flow.
      Parameters:
      visitor - The visitor to add the start definitions to.
      Throws:
      InitializationException - This exception is thrown if the start definitions could not be initialized.