Package de.elo.mover.main.helper

Class ReportHelper

  • public class ReportHelper
extends java.lang.Object

    Überschrift: ReportHelper.

    Beschreibung: Hilfsklasse für den Report von ELOas-Regeln.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      ReportHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addReportEntry​(IXconnect ixConnect, int objId, int actionNo, int extra1, int extra2, java.lang.String message)
      Schreibt einen Report Eintrag in die Datenbank.
      static void configureReportLogger​(WebAppContextParam webAppContextParam)
      Konfiguriert den Logger für den AS-Report.
      static boolean containsReportInfo​(de.elo.ix.client.ReportInfo[] reportInfos, de.elo.ix.client.ReportInfo reportInfo)
      Meldet zurück, ob das angegebene ReportInfo Objekt in der Liste mit den ReportInfo Objekten vorhanden ist.
      static int getLastDocumentId​(IXconnect ixConnect)
      Liefert die letzte physikalische Dokumentennummer im Archiv zurück.
      static de.elo.ix.client.ReportInfo getReportInfo​(IXconnect ixConnect, int objId, int userId, int actionNo, java.lang.String comment, int extra1, int extra2, java.lang.String extraInfo)
      Erzeugt ein ReportInfo Objekt aus den angegebenen Daten.
      static de.elo.ix.client.ReportInfoUserProps getReportInfoUserProps​(IXconnect ixConnect, int userId)
      Liefert das ReportInfoUserProps Objekt für den angegebenen Benutzer zurück.
      static java.util.ArrayList<de.elo.ix.client.ReportInfo> getReportList​(IXconnect ixConnect, de.elo.ix.client.FindReportInfo findInfo)
      Liefert eine Liste mit den Reporteinträgen für die angegebenen Suchkriterien zurück.
      static java.lang.String getReportMode​(IXconnect ixConnect)
      Liefert den Report Modus aus den Reportoptionen zurück.
      static java.lang.String resolveReportPath​(java.lang.String reportPath)
      Liefert die aufgelösten Pfad der Reportdatei zurück.
      static void saveReport​(IXconnect ixConnect, int userId, int objId, int actionNr, java.lang.String startDate, java.lang.String endDate, int maxReportCount, java.io.File targetFile)
      Speichert die Reportdaten in der angegebenen Textdatei.
      static void saveRuleReport​(RuleReport ruleReport)
      Speichert den angegebenen Report in der eingestellten csv-Datei.
      static void setUserNameInReport​(IXconnect ixConnect, RuleReport ruleReport, int userId)
      Setzt den Benutzernamen im angegebenen Report-Objekt.
      static void writeReportInfos​(java.util.ArrayList<de.elo.ix.client.ReportInfo> reportInfos, int actionNr, int maxReportCount, java.io.File targetFile)
      Schreibt die Reportdaten in der angegebenen Textdatei.
      static void writeRuleReportHeader()
      Schreibt die Report-Header in der eingestellten Report-Datei.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReportHelper

        public ReportHelper()

    • Method Detail

      • configureReportLogger

        public static void configureReportLogger​(WebAppContextParam webAppContextParam)
        Konfiguriert den Logger für den AS-Report.
        Parameters:
        webAppContextParam - Parameter der Anwendung

      • resolveReportPath

        public static java.lang.String resolveReportPath​(java.lang.String reportPath)
        Liefert die aufgelösten Pfad der Reportdatei zurück.
        Parameters:
        reportPath - Pfad der Reportdatei
        Returns:
        Aufgelösten Pfad der Reportdatei

      • writeRuleReportHeader

        public static void writeRuleReportHeader()
        Schreibt die Report-Header in der eingestellten Report-Datei.

      • saveRuleReport

        public static void saveRuleReport​(RuleReport ruleReport)
        Speichert den angegebenen Report in der eingestellten csv-Datei.
        Parameters:
        ruleReport - Regelreport

      • setUserNameInReport

        public static void setUserNameInReport​(IXconnect ixConnect,
                                       RuleReport ruleReport,
                                       int userId)
        Setzt den Benutzernamen im angegebenen Report-Objekt.
        Parameters:
        ixConnect - Index Server Verbindung
        ruleReport - Report-Objekt
        userId - Benutzerid

      • addReportEntry

        public static void addReportEntry​(IXconnect ixConnect,
                                  int objId,
                                  int actionNo,
                                  int extra1,
                                  int extra2,
                                  java.lang.String message)
                           throws java.lang.Exception
        Schreibt einen Report Eintrag in die Datenbank. Der Parameter "actionNo" muss im Bereich von 3000 bis 3999 liegen.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ELO Objekt zu dem der Reporteintrag geschrieben werden soll
        actionNo - Aktionsnummer, Anwenderdefiniert, 3000...3999
        extra1 - Datenbankfeld extra1
        extra2 - Datenbankfeld extra2
        message - Kommentarfeld
        Throws:
        java.lang.Exception - Wenn der Reporteintrag nicht angelegt werden kann

      • getReportInfo

        public static de.elo.ix.client.ReportInfo getReportInfo​(IXconnect ixConnect,
                                                        int objId,
                                                        int userId,
                                                        int actionNo,
                                                        java.lang.String comment,
                                                        int extra1,
                                                        int extra2,
                                                        java.lang.String extraInfo)
                                                 throws java.lang.Exception
        Erzeugt ein ReportInfo Objekt aus den angegebenen Daten.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        userId - Benutzer ID
        actionNo - Aktion Nummer
        comment - Kommentar der Aktion
        extra1 - Erstes Feld
        extra2 - Zweites Feld
        extraInfo - Zusätzliche Information
        Returns:
        ReportInfo Objekt
        Throws:
        java.lang.Exception

      • containsReportInfo

        public static boolean containsReportInfo​(de.elo.ix.client.ReportInfo[] reportInfos,
                                         de.elo.ix.client.ReportInfo reportInfo)
                                  throws java.lang.Exception
        Meldet zurück, ob das angegebene ReportInfo Objekt in der Liste mit den ReportInfo Objekten vorhanden ist.
        Parameters:
        reportInfos - Liste mit ReportInfo Objekten
        reportInfo - ReportInfo Objekt
        Returns:
        ReportInfo Objekt ist vorhanden
        Throws:
        java.lang.Exception

      • getReportInfoUserProps

        public static de.elo.ix.client.ReportInfoUserProps getReportInfoUserProps​(IXconnect ixConnect,
                                                                          int userId)
                                                                   throws java.lang.Exception
        Liefert das ReportInfoUserProps Objekt für den angegebenen Benutzer zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        userId - Benutzer ID
        Returns:
        ReportInfoUserProps
        Throws:
        java.lang.Exception

      • saveReport

        public static void saveReport​(IXconnect ixConnect,
                              int userId,
                              int objId,
                              int actionNr,
                              java.lang.String startDate,
                              java.lang.String endDate,
                              int maxReportCount,
                              java.io.File targetFile)
                       throws java.lang.Exception
        Speichert die Reportdaten in der angegebenen Textdatei.
        Parameters:
        ixConnect - Index Server Verbindung
        userId - Benutzer ID oder -1 für keine Einschränkung
        objId - ID des Archiveintrags
        actionNr - Aktionsnummer für den Filter oder -1 für alle Reporteinträge
        startDate - Startdatum oder null für keine Einschränkung
        endDate - Enddatum oder null für keine Einschränkung
        maxReportCount - Maximale Anzahl an Reporteinträgen
        targetFile - Textdatei, in der der Report geschrieben wird
        Throws:
        java.lang.Exception

      • writeReportInfos

        public static void writeReportInfos​(java.util.ArrayList<de.elo.ix.client.ReportInfo> reportInfos,
                                    int actionNr,
                                    int maxReportCount,
                                    java.io.File targetFile)
                             throws java.lang.Exception
        Schreibt die Reportdaten in der angegebenen Textdatei.
        Parameters:
        reportInfos - Liste mit Reportdaten
        actionNr - Aktion ID für den Filter oder -1 für alle Reporteinträge
        maxReportCount - Maximale Anzahl an Reporteinträgen
        targetFile - Zieldatei für die Reporteinträge
        Throws:
        java.lang.Exception

      • getReportList

        public static java.util.ArrayList<de.elo.ix.client.ReportInfo> getReportList​(IXconnect ixConnect,
                                                                             de.elo.ix.client.FindReportInfo findInfo)
                                                                      throws java.lang.Exception
        Liefert eine Liste mit den Reporteinträgen für die angegebenen Suchkriterien zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        findInfo - Suchkriterien
        Returns:
        Liste mit Reporteinträgen
        Throws:
        java.lang.Exception

      • getReportMode

        public static java.lang.String getReportMode​(IXconnect ixConnect)
                                      throws java.lang.Exception
        Liefert den Report Modus aus den Reportoptionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Report Modus
        Throws:
        java.lang.Exception

      • getLastDocumentId

        public static int getLastDocumentId​(IXconnect ixConnect)
                             throws java.lang.Exception
        Liefert die letzte physikalische Dokumentennummer im Archiv zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        letzte physikalische Dokumentennummer
        Throws:
        java.lang.Exception