Package de.elo.mover.main.helper

Class WorkflowHelper

java.lang.Object
de.elo.mover.main.helper.WorkflowHelper
public class WorkflowHelper extends Object

Überschrift: WorkflowHelper.

Beschreibung: Hilfsklasse für Workflow-Operationen.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2022

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorkflowHelper()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    addWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeType, String nodeName, int userId, int xPos, int yPos)
    Fügt den Workfowknoten an der angegebenen Position in den Workflow ein und liefert die ID des neuen Workflow-Knotens zurück.
    static void
    addWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId)
    Fügt eine Verbindung zwischen den angegebenen Workflow-Knoten ein.
    static de.elo.ix.client.StartAdHocWorkflowInfo
    createStartWorkflowInfo(String startNodeName, boolean forValidation, boolean serialFlow, boolean deactivateNodes, String cancelUserId, String finishUserId)
    Erzeugt ein Objekt für den Start eines Adhoc Workflows mit den angegebenen Daten.
    static void
    deleteReminders(IXconnect ixConnect, int objId)
    Löscht die Wiedervorlagen mit dem angegebenen Eintrag.
    static void
    deleteWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeId)
    Löscht den angegebenen Workflow-Knoten.
    static void
    deleteWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId)
    Löscht die angegebene Knotenverbindung im angegebenen Workflow.
    static void
    execDeleteWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeId)
    Löscht den angegebenen Workflow-Knoten.
    static void
    execDeleteWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId)
    Löscht die angegebene Knotenverbindung im angegebenen Workflow.
    static File
    exportWorkflowTemplate(IXconnect ixConnect, int flowTemplId, File targetDir)
    Exportiert die Workflow-Vorlage im angegebenen Zielverzeichnis und liefert die erstellte EWF-Datei zurück.
    static void
    forwardNode(IXconnect ixConnect, de.elo.ix.client.WFCollectNode node, String comment)
    Leitet die Workflow Bearbeitung vom angegebenen Workflow-Knoten weiter.
    static String
    getDesc(de.elo.ix.client.UserTask task)
    Liefert den Zusatztext der angegebenen Aufgabe zurück.
    static int
    getFirstSuccNodeId(de.elo.ix.client.WFDiagram wfDiagram, int nodeId)
    Liefert die ID des ersten Nachfolgerknotens zurück.
    static String
    getFormName(IXconnect ixConnect, int flowId, int nodeId)
    Liefert die Formularbezeichnung des angegebenen Workflow-Knotens zurück.
    static String
    getFormNameFromUrl(String requestUri)
    Liefert den JSP-Formularnamen aus der angegebenen Request-URL zurück.
    static de.elo.ix.client.WFNode
    getMaxNode(de.elo.ix.client.WFNode[] nodes)
    Liefert den Knoten mit der größten KnotenId zurück.
    static int
    getMaxNodeId(de.elo.ix.client.WFNode[] nodes)
    Liefert die größte KnotenId aus den angegebenen Workflow-Knoten zurück.
    static String
    getName(de.elo.ix.client.UserTask task)
    Liefert die Bezeichnung der angegebenen Aufgabe zurück.
    static de.elo.ix.client.WFNode
    getNodeById(de.elo.ix.client.WFDiagram flow, int nodeId)
    Liefert den Workflow-Knoten mit der angegebenen ID zurück.
    static de.elo.ix.client.WFNode
    getNodeById(IXconnect ixConnect, int flowId, int nodeId)
    Liefert den Workflowknoten mit der angegebenen ID zurück.
    static int
    getNodesCount(IXconnect ixConnect, int flowId)
    Liefert die Anzahl der Knoten im angegebenen Workflow zurück.
    static ArrayList<de.elo.ix.client.WFNode>
    getNodesRange(IXconnect ixConnect, int flowId, int startNodeId, int endNodeId)
    Liefert eine Liste mit Workflow Knoten, deren IDs zwischen den angegebenen IDs liegen.
    static String
    getObjId(de.elo.ix.client.UserTask task)
    Liefert die Objekt ID der angegebenen Aufgabe zurück.
    static int
    getReceiverId(de.elo.ix.client.UserTask task)
    Liefert den Empfänger der angegebenen Aufgabe zurück.
    static List<de.elo.ix.client.Reminder>
    getReminders(IXconnect ixConnect, int userId)
    Liefert alle Wiedervorlagen vom Indexserver zurück.
    static de.elo.ix.client.WFNode
    getSuccessor(IXconnect ixConnect, int flowId, int nodeId)
    Liefert den Nachfolgerknoten des angegebenen Workflow Knotens zurück.
    static de.elo.ix.client.WFNode[]
    getSuccessors(IXconnect ixConnect, int flowId, int nodeId)
    Liefert eine Liste mit den Nachfolgerknoten des angegebenen Workflow Knotens zurück.
    static int
    getVersionsCount(IXconnect ixConnect, int flowId)
    Liefert die Anzahl der Versionen der angegebenen Workflow-Vorlage zurück.
    static String
    getWfBaseUrl(IXconnect ixConnect)
    Liefert die Haupt URL vom Workflow Server zurück.
    static List<de.elo.ix.client.WFDiagram>
    getWorkflows(IXconnect ixConnect, de.elo.ix.client.FindWorkflowInfo findWorkflowInfo)
    Liefert die Workflows für die angegebenen Suchkriterien zurück.
    static de.elo.ix.client.WFDiagram
    importWorkflowTemplate(IXconnect ixConnect, File ewfFile)
    Importiert die angegebene EWF-Datei im Indexserver.
    static void
    invalidateWorkflowCache(IXconnect ixConnect, int flowId)
    Entfernt den angegebenen Workflow vom Workflow-Cache vom Indexserver.
    static boolean
    isWorkflowCacheEnabled(IXconnect ixConnect)
    Meldet zurück, ob der Workflow-Cache aktiviert wurde.
    static void
    resetWorkflowNode(de.elo.ix.client.WFNode node)
    Setzt die Datumseigenschaften des angegebenen Workflow-Knotens zurück.
    static void
    setSessionStartDocMaskWorkflows(IXconnect ixConnect, boolean startWorkflows)
    Setzt die Option für den automatischen Start von Workflows, die in einer Maske hinterlegt sind.
    static void
    terminateWorkflows(IXconnect ixConnect, int objId)
    Beendet alle aktiven Workflows des angegebenen Eintrags.
    static boolean
    userHasTaskForSord(IXconnect ixConnect, String userName, int flowId, int objId)
    Meldet zurück, ob der Benutzer einen Workflow für den angegebenen Eintrag bekommen hat.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WorkflowHelper

      public WorkflowHelper()

  • Method Details

    • addWorkflowNode

      public static int addWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeType, String nodeName, int userId, int xPos, int yPos) throws Exception
      Fügt den Workfowknoten an der angegebenen Position in den Workflow ein und liefert die ID des neuen Workflow-Knotens zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflowtyp
      nodeType - Knotentyp
      nodeName - Knotennamen
      userId - BenutzerId
      xPos - Horizontale Knotenposition
      yPos - Vertikale Knotenposition
      Returns:
      Id des neuen Knotens
      Throws:
      Exception

    • addWorkflowNodeAssoc

      public static void addWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId) throws Exception
      Fügt eine Verbindung zwischen den angegebenen Workflow-Knoten ein.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflow-Type
      startNodeId - Startknoten der Verbindung
      endNodeId - Endknoten der Verbindung
      Throws:
      Exception

    • deleteWorkflowNodeAssoc

      public static void deleteWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId) throws byps.RemoteException, Exception
      Löscht die angegebene Knotenverbindung im angegebenen Workflow.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflow-Typ
      startNodeId - Id des Startknotens der Knotenverbindung
      endNodeId - Id des Endknotens der Knotenverbindung
      Throws:
      byps.RemoteException
      Exception

    • execDeleteWorkflowNodeAssoc

      public static void execDeleteWorkflowNodeAssoc(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int startNodeId, int endNodeId) throws byps.RemoteException
      Löscht die angegebene Knotenverbindung im angegebenen Workflow.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflow-Typ
      startNodeId - Id des Startknotens der Knotenverbindung
      endNodeId - Id des Endknotens der Knotenverbindung
      Throws:
      byps.RemoteException

    • deleteWorkflowNode

      public static void deleteWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeId) throws Exception
      Löscht den angegebenen Workflow-Knoten.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflowtyp
      nodeId - KnotenId
      Throws:
      Exception

    • execDeleteWorkflowNode

      public static void execDeleteWorkflowNode(IXconnect ixConnect, int flowId, de.elo.ix.client.WFTypeZ flowType, int nodeId) throws byps.RemoteException, Exception
      Löscht den angegebenen Workflow-Knoten.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - WorkflowId
      flowType - Workflow-Typ
      nodeId - KnotenId
      Throws:
      byps.RemoteException
      Exception

    • getNodesCount

      public static int getNodesCount(IXconnect ixConnect, int flowId) throws byps.RemoteException, Exception
      Liefert die Anzahl der Knoten im angegebenen Workflow zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-Id
      Returns:
      Anzahl der Knoten
      Throws:
      byps.RemoteException
      Exception

    • getNodesRange

      public static ArrayList<de.elo.ix.client.WFNode> getNodesRange(IXconnect ixConnect, int flowId, int startNodeId, int endNodeId) throws Exception
      Liefert eine Liste mit Workflow Knoten, deren IDs zwischen den angegebenen IDs liegen.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      startNodeId - Startindex
      endNodeId - Endindex
      Returns:
      Liste Mit Workflow Knoten
      Throws:
      Exception

    • getVersionsCount

      public static int getVersionsCount(IXconnect ixConnect, int flowId) throws byps.RemoteException, Exception
      Liefert die Anzahl der Versionen der angegebenen Workflow-Vorlage zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - ID der Workflow-Vorlage
      Returns:
      Anzahl der Versionen
      Throws:
      byps.RemoteException
      Exception

    • getNodeById

      public static de.elo.ix.client.WFNode getNodeById(IXconnect ixConnect, int flowId, int nodeId) throws Exception
      Liefert den Workflowknoten mit der angegebenen ID zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      nodeId - Knoten-ID
      Returns:
      Workflow-Knoten oder null
      Throws:
      Exception

    • getNodeById

      public static de.elo.ix.client.WFNode getNodeById(de.elo.ix.client.WFDiagram flow, int nodeId) throws Exception
      Liefert den Workflow-Knoten mit der angegebenen ID zurück.
      Parameters:
      flow - Workflow-Diagramm
      nodeId - Knoten-ID
      Returns:
      Workflow-Knoten oder null
      Throws:
      Exception

    • getSuccessor

      public static de.elo.ix.client.WFNode getSuccessor(IXconnect ixConnect, int flowId, int nodeId) throws Exception
      Liefert den Nachfolgerknoten des angegebenen Workflow Knotens zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow ID
      nodeId - Knoten ID
      Returns:
      Nachfolgerknoten oder null
      Throws:
      Exception

    • getSuccessors

      public static de.elo.ix.client.WFNode[] getSuccessors(IXconnect ixConnect, int flowId, int nodeId) throws Exception
      Liefert eine Liste mit den Nachfolgerknoten des angegebenen Workflow Knotens zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      nodeId - Knoten-ID
      Returns:
      Liste mit Nachfolgerknoten oder null
      Throws:
      Exception

    • getFirstSuccNodeId

      public static int getFirstSuccNodeId(de.elo.ix.client.WFDiagram wfDiagram, int nodeId) throws Exception
      Liefert die ID des ersten Nachfolgerknotens zurück.
      Parameters:
      wfDiagram - Workflow Diagramm
      nodeId - Knoten ID
      Returns:
      ID des ersten Nachfolgerknotens oder -1
      Throws:
      Exception

    • getWorkflows

      public static List<de.elo.ix.client.WFDiagram> getWorkflows(IXconnect ixConnect, de.elo.ix.client.FindWorkflowInfo findWorkflowInfo) throws Exception
      Liefert die Workflows für die angegebenen Suchkriterien zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      findWorkflowInfo - Suchkriterien
      Returns:
      Liste mit Workflows
      Throws:
      Exception

    • getReminders

      public static List<de.elo.ix.client.Reminder> getReminders(IXconnect ixConnect, int userId) throws Exception
      Liefert alle Wiedervorlagen vom Indexserver zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      Returns:
      Liste mit den Wiedervorlagen
      Throws:
      Exception

    • getName

      public static String getName(de.elo.ix.client.UserTask task) throws Exception
      Liefert die Bezeichnung der angegebenen Aufgabe zurück.
      Parameters:
      task - Aufgabe
      Returns:
      Bezeichnung der Aufgabe
      Throws:
      Exception

    • getDesc

      public static String getDesc(de.elo.ix.client.UserTask task) throws Exception
      Liefert den Zusatztext der angegebenen Aufgabe zurück.
      Parameters:
      task - Aufgabe
      Returns:
      Zusatztext der Aufgabe
      Throws:
      Exception

    • getObjId

      public static String getObjId(de.elo.ix.client.UserTask task) throws Exception
      Liefert die Objekt ID der angegebenen Aufgabe zurück.
      Parameters:
      task - Aufgabe
      Returns:
      ID der Aufgabe
      Throws:
      Exception

    • getReceiverId

      public static int getReceiverId(de.elo.ix.client.UserTask task) throws Exception
      Liefert den Empfänger der angegebenen Aufgabe zurück.
      Parameters:
      task - Aufgabe
      Returns:
      Empfänger der Aufgabe
      Throws:
      Exception

    • resetWorkflowNode

      public static void resetWorkflowNode(de.elo.ix.client.WFNode node) throws Exception
      Setzt die Datumseigenschaften des angegebenen Workflow-Knotens zurück.
      Parameters:
      node - Workflow-Knoten
      Throws:
      Exception

    • getMaxNodeId

      public static int getMaxNodeId(de.elo.ix.client.WFNode[] nodes) throws Exception
      Liefert die größte KnotenId aus den angegebenen Workflow-Knoten zurück.
      Parameters:
      nodes - Liste mit Workflow-Knoten
      Returns:
      Größe KnotenId
      Throws:
      Exception

    • getMaxNode

      public static de.elo.ix.client.WFNode getMaxNode(de.elo.ix.client.WFNode[] nodes) throws Exception
      Liefert den Knoten mit der größten KnotenId zurück.
      Parameters:
      nodes - Liste mit Workflowknoten
      Returns:
      Knoten mit größter ID
      Throws:
      Exception

    • importWorkflowTemplate

      public static de.elo.ix.client.WFDiagram importWorkflowTemplate(IXconnect ixConnect, File ewfFile) throws Exception
      Importiert die angegebene EWF-Datei im Indexserver.
      Parameters:
      ixConnect - Indexserver-Verbindung
      ewfFile - EWF-Datei
      Returns:
      importierte Workflow-Vorlage
      Throws:
      Exception

    • exportWorkflowTemplate

      public static File exportWorkflowTemplate(IXconnect ixConnect, int flowTemplId, File targetDir) throws Exception
      Exportiert die Workflow-Vorlage im angegebenen Zielverzeichnis und liefert die erstellte EWF-Datei zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowTemplId - ID der Workflow-Vorlage
      targetDir - Zielverzeichnis
      Returns:
      Exportierte EWF-Datei
      Throws:
      Exception

    • terminateWorkflows

      public static void terminateWorkflows(IXconnect ixConnect, int objId) throws Exception
      Beendet alle aktiven Workflows des angegebenen Eintrags.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Throws:
      Exception

    • deleteReminders

      public static void deleteReminders(IXconnect ixConnect, int objId) throws Exception
      Löscht die Wiedervorlagen mit dem angegebenen Eintrag.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Throws:
      Exception

    • getFormName

      public static String getFormName(IXconnect ixConnect, int flowId, int nodeId) throws Exception
      Liefert die Formularbezeichnung des angegebenen Workflow-Knotens zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      nodeId - ID des Workflow Knotens
      Returns:
      Formularbezeichnung des Knotens
      Throws:
      Exception

    • getFormNameFromUrl

      public static String getFormNameFromUrl(String requestUri) throws Exception
      Liefert den JSP-Formularnamen aus der angegebenen Request-URL zurück.
      Parameters:
      requestUri - komplette URL ohne Parameter
      Returns:
      Formularname ohne ".JSP" Anteil
      Throws:
      Exception

    • getWfBaseUrl

      public static String getWfBaseUrl(IXconnect ixConnect) throws Exception
      Liefert die Haupt URL vom Workflow Server zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Haupt URL vom Workflow Server
      Throws:
      Exception

    • isWorkflowCacheEnabled

      public static boolean isWorkflowCacheEnabled(IXconnect ixConnect) throws Exception
      Meldet zurück, ob der Workflow-Cache aktiviert wurde.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Workflow Cache wurde aktiviert
      Throws:
      Exception

    • forwardNode

      public static void forwardNode(IXconnect ixConnect, de.elo.ix.client.WFCollectNode node, String comment) throws Exception
      Leitet die Workflow Bearbeitung vom angegebenen Workflow-Knoten weiter.
      Parameters:
      ixConnect - Indexserver-Verbindung
      node - Workflow-Knoten
      comment - Kommentar
      Throws:
      Exception

    • createStartWorkflowInfo

      public static de.elo.ix.client.StartAdHocWorkflowInfo createStartWorkflowInfo(String startNodeName, boolean forValidation, boolean serialFlow, boolean deactivateNodes, String cancelUserId, String finishUserId) throws Exception
      Erzeugt ein Objekt für den Start eines Adhoc Workflows mit den angegebenen Daten.
      Parameters:
      startNodeName - Bezeichnung des Startknotens
      forValidation - Zur Überprüfung
      serialFlow - Serielle Bearbeitung
      deactivateNodes - Personenknoten deaktivieren
      cancelUserId - Benutzer ID beim Abbruch des Workflows
      finishUserId - Benutzer ID beim Beenden des Workflows
      Returns:
      Objekt für den Start eines Adhoc Workflows
      Throws:
      Exception

    • setSessionStartDocMaskWorkflows

      public static void setSessionStartDocMaskWorkflows(IXconnect ixConnect, boolean startWorkflows) throws Exception
      Setzt die Option für den automatischen Start von Workflows, die in einer Maske hinterlegt sind.
      Parameters:
      ixConnect - Indexserver-Verbindung
      startWorkflows - Workflows automatisch starten
      Throws:
      Exception

    • userHasTaskForSord

      public static boolean userHasTaskForSord(IXconnect ixConnect, String userName, int flowId, int objId) throws Exception
      Meldet zurück, ob der Benutzer einen Workflow für den angegebenen Eintrag bekommen hat.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userName - Benutzername
      flowId - Workflow-ID
      objId - Objekt-ID des Eintrags
      Returns:
      Benutzer hat einen Workflow bekommen
      Throws:
      Exception

    • invalidateWorkflowCache

      public static void invalidateWorkflowCache(IXconnect ixConnect, int flowId) throws Exception
      Entfernt den angegebenen Workflow vom Workflow-Cache vom Indexserver.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      Throws:
      Exception