Package de.elo.client.scripting.interfaces

Klasse UtilsAdapter

Object
UtilsAdapter
public class UtilsAdapter extends Object

Überschrift: UtilsAdapter

Beschreibung: Hilftmethoden für Skripte im Client. Im Scripting verfügbar als "utils".

Copyright: Copyright (c) ELO Digital Office GmbH 2011-2016

Seit:
8.00.000

  • Konstruktordetails

    • UtilsAdapter

      public UtilsAdapter(Workspace workspace)
      Interner Konstruktor.
      Parameter:
      workspace - Aktueller Arbeitsbereich

  • Methodendetails

    • transferByClipboard

      public String transferByClipboard(boolean withDoubleClick, boolean withCtrlC) throws Exception
      Führt (optional) einen Doppelklick und ein STRG-C aus und liest anschließend das Windows Clipboard ein.
      Parameter:
      withDoubleClick - Simuliert einen Doppelklick auf die aktuelle Mausposition
      withCtrlC - Simuliert den Tastendruck STRG-C
      Gibt zurück:
      Textinhalt des Clipboards
      Löst aus:
      Exception - Wenn nicht auf das Clipboard zugegriffen werden kann, oder der Inhalt nicht als Text verfügbar ist.

    • findByMd5

      public Sord findByMd5(File searchForFile) throws Exception
      Prüft nach, ob es zu einer Datei eine Dublette im Archiv gibt. Wenn ja, wird die (erste) Dublette zurück geliefert.
      Parameter:
      searchForFile - Datei
      Gibt zurück:
      Dublette oder null
      Löst aus:
      Exception - Wenn der Serverzugriff fehlschlägt.
      Seit:
      10.00.000

    • findListByMd5

      public List<Sord> findListByMd5(File searchForFile) throws Exception
      Prüft nach, ob es zu einer Datei Dubletten im Archiv gibt. Wenn ja, wird die Liste der Dublette zurück geliefert.
      Parameter:
      searchForFile - Datei
      Gibt zurück:
      Liste der Dubletten oder null
      Löst aus:
      Exception - Wenn der Serverzugriff fehlschlägt.
      Seit:
      21.02.005

    • getMD5

      public String getMD5(File file) throws IOException
      Ermittelt den MD5 Hash Wert zum Inhalt einer Datei.
      Parameter:
      file - Zu prüfende Datei
      Gibt zurück:
      MD5 Wert als Hex-String
      Löst aus:
      IOException - Wenn die Datei nicht gelesen werden kann oder der MD5 Wert nicht errechnet werden kann.
      Seit:
      10.00.000

    • addToClipboard

      public void addToClipboard(String htmlText, String plainText)
      Fügt einen Eintrag als Text und HTML Eintrag in das Windows Clipboard ein.
      Parameter:
      htmlText - HTML formatierte Version des Textes
      plainText - Unformatierte Version des Textes
      Seit:
      9.03.000

    • mergeTiff

      public void mergeTiff(File[] fileNames, File destination) throws Exception
      Fasst mehrere Tiff Dateien zu einer Datei zusammen.
      Parameter:
      fileNames - Array mit den Quelldateien
      destination - Zieldatei
      Löst aus:
      Exception - Wenn die Dateien nicht zusammengefasst werden konnten.
      Seit:
      9.00.028

    • mergePdf

      public void mergePdf(File[] fileNames, File destination) throws Exception
      Fasst mehrere PDF Dateien zu einer Datei zusammen.
      Parameter:
      fileNames - Array mit den Quelldateien
      destination - Zieldatei
      Löst aus:
      Exception - Wenn die Dateien nicht zusammengefasst werden konnten.
      Seit:
      9.00.028

    • splitPdf

      public List<File> splitPdf(File source) throws Exception
      Trennt eine mehrseitige TIFF-Datei in Einzelseiten auf.
      Parameter:
      source - Quelldatei
      Gibt zurück:
      Liste der erzeugten Dateien
      Löst aus:
      Exception - Wenn die Seiten nicht getrennt werden konnten.
      Seit:
      12.00.000

    • splitTiff

      public List<File> splitTiff(File source) throws Exception
      Trennt eine mehrseitige TIFF-Datei in Einzelseiten auf.
      Parameter:
      source - Quelldatei
      Gibt zurück:
      Liste der erzeugten Dateien
      Löst aus:
      Exception - Wenn die Seiten nicht getrennt werden konnten.
      Seit:
      12.00.000

    • getPageCount

      public int getPageCount(File file) throws IOException
      Liefert die Seitenzahl für PDF oder Bild-Dateien.
      Parameter:
      file - Bild- oder PDF-Datei
      Gibt zurück:
      Seitenzahl
      Löst aus:
      IOException - Bei nicht lesbaren Dateien oder nicht unterstützten Dateiformaten
      Seit:
      12.19, 20.15, 23.00.001

    • editFile

      public void editFile(File file)
      Öffnet die Datei mit dem vom Betriebssystem dafür vorgesehenen Programm zur Bearbeitung.
      Parameter:
      file - Zu öffnende Datei
      Seit:
      8.00.000

    • getFileNameWithOption

      public String getFileNameWithOption(Sord sord)
      Liefert den Dateinamen des angegebenen Archiveintrags unter Beachtung der ensprechenden Client-Option. Bei ungültiger Parameterangabe wird null zurückgeliefert.
      Parameter:
      sord - Archiveintrag
      Gibt zurück:
      Dateiname
      Seit:
      8.00.000

    • getDocMaskFromOpts

      public int getDocMaskFromOpts(String fileName, int parentId) throws RemoteException
      Liefert die MaskId der Dokumentenmaske zurück, die zu einer Dateiendung zugeordnet wurde. Falls für den angegebenen Dateityp keine Maske definiert ist, wird die MaskId der Default-Maske zurückgegeben.
      Parameter:
      fileName - Dateiname (null, für: Ordner)
      parentId - ID des Elternelements (-1, für: noch nicht bekannt, keine Einschränkung durch beschränkte Maskenverwendung aus Parent)
      Gibt zurück:
      MaskId ID der Dokumentenmaske
      Löst aus:
      RemoteException
      Seit:
      12.16.000, 20.12.000, 21.03.000

    • getUniqueFile

      public File getUniqueFile(File directory, String fileNameWithExtension)
      Liefert eine eindeutige Datei für den angegebenen Dateinamen in dem angegebenen Verzeichnis. Bei ungültiger Parameterangabe wird null zurückgeliefert.
      Parameter:
      directory - Verzeichnis, in dem die Datei erzeugt wird
      fileNameWithExtension - Dateiname mit Dateiendung
      Gibt zurück:
      Eindeutige Datei oder null bei einem Fehler
      Seit:
      8.00.000

    • copyFile

      public boolean copyFile(File sourceFile, File targetFile)
      Kopiert die angegebene Quelldatei in die angegebene Zieldatei und meldet das Ergebnis zurück. Bei ungültigen Parameterangaben wird false zurückgegeben.
      Parameter:
      sourceFile - Quelldatei
      targetFile - Zieldatei
      Gibt zurück:
      Kopierergebnis: True wenn kopiert wurden, False bei einem Fehler
      Seit:
      8.00.000

    • getFileExtension

      public String getFileExtension(File file)
      Liefert die Dateiendung der angegebenen Datei zurück. Bei ungültiger Parameterangabe wird null zurückgeliefert.
      Parameter:
      file - Datei
      Gibt zurück:
      Dateiendung oder null bei einem Fehler
      Seit:
      8.00.000

    • getFileNameWithoutExtension

      public String getFileNameWithoutExtension(File file)
      Liefert den Dateinamen ohne die Dateiendung zurück. Bei ungültiger Parameterangabe wird null zurückgeliefert.
      Parameter:
      file - Datei
      Gibt zurück:
      Dateiname ohne Dateiendung oder null bei einem Fehler
      Seit:
      8.00.000

    • changeFileExtension

      public File changeFileExtension(File file, String newFileExt)
      Liefert eine Datei mit der neuen Dateiendung zurück. Die Dateiendung muss mindestens ein Zeichen lang sein. Bei ungültigen Paramterangaben wird null zurückgeliefert.
      Parameter:
      file - Datei, deren Dateiendung geändert wird
      newFileExt - Neue Dateiendung
      Gibt zurück:
      Neue Datei oder null bei einem Fehler
      Seit:
      8.00.000

    • dateFromIso

      public Date dateFromIso(String isoDate)
      Konvertiert das angegebene Iso-Datum zu einem Java-Datum. Bei ungültigen Parameterangaben wird null zurückgeliefert.
      Parameter:
      isoDate - Datum in ISO Schreibweise YYYYMMDDHHMMSS
      Gibt zurück:
      Java-Datum oder null bei einem Fehler
      Seit:
      8.00.000

    • dateFromString

      public Date dateFromString(String date)
      Konvertiert den Eingabestring in ein Date Objekt in Abhängigkeit der aktuellen Einstellungen.
      Parameter:
      date - Datumsangabe
      Gibt zurück:
      Erkanntes Datum
      Seit:
      10.00.000

    • displayDateFromIso

      public String displayDateFromIso(String isoDate)
      Formatiert den angegebenen ISO-Datumsstring in eine Datumsanzeige um. Dabei wird die übliche Formatierung M/D/Y oder T.M.J berücksichtigt. Falls das Datum auch eine Uhrzeit enthält, wird diese ignoriert. Bei null wir ein leerer String zurückgegeben.
      Parameter:
      isoDate - Datum in ISO Schreibweise YYYYMMDDHHMMSS
      Gibt zurück:
      Formatierte Datumsanzeige
      Seit:
      8.00.000

    • displayDateFromIsoWithTime

      public String displayDateFromIsoWithTime(String isoDate)
      Formatiert einen ISO Datumsstring in eine Datumsanzeige um. Dabei wird die übliche Formatierung M/D/Y oder T.M.J berücksichtigt. Falls das Datum auch eine Uhrzeit enthält, wird diese ebenfalls formatiert. Bei null wir ein leerer String zurückgegeben.
      Parameter:
      isoDate - Datum in ISO Schreibweise YYYYMMDD oder YYYYMMDDHHMMSS
      Gibt zurück:
      Formatierte Datumsanzeige
      Seit:
      8.00.000

    • isoFromDate

      public String isoFromDate(Date date)
      Konvertiert das angegebene Java-Datum nach einem Iso-Datum. Bei ungültigen Paramterangaben wird null zurückgeliefert.
      Parameter:
      date - Java-Datum
      Gibt zurück:
      Datum in ISO Schreibweise YYYYMMDDHHMMSS
      Seit:
      8.00.000

    • eloDateFromJavaDate

      public int eloDateFromJavaDate(Date date)
      Erzeugt aus dem angegebene Java-Datum ein ELO-Datum. Das interne Java Datum läuft in Millisekunden vom 1.1.1970, das ELO Datum in Minuten vom 1.1.1900
      Parameter:
      date - Java-Datum
      Gibt zurück:
      ELO-Datum
      Seit:
      8.00.000

    • eloDateFromJavaDate

      public int eloDateFromJavaDate(long date)
      Erzeugt aus dem angegebene Java-Datum ein ELO-Datum. Das interne Java Datum läuft in Millisekunden vom 1.1.1970, das ELO Datum in Minuten vom 1.1.1900
      Parameter:
      date - Java-Datum
      Gibt zurück:
      ELO-Datum
      Seit:
      8.00.000

    • getDateWithoutTime

      public Date getDateWithoutTime(Date date)
      Liefert das übergebene Datum ohne Uhrzeit zurück (0:00:00.000).
      Parameter:
      date - Java-Datum
      Gibt zurück:
      Java-Datum ohne Uhrzeit
      Seit:
      8.00.000

    • getNow

      public Date getNow(int offsetMinutes)
      Liefert ein Datum mit der aktuellen Uhrzeit und die addierten angegebenen Minuten zurück.
      Parameter:
      offsetMinutes - Anzahl der Minuten, die zur aktuellen Zeit addiert werden
      Gibt zurück:
      Datum
      Seit:
      8.00.000

    • getToday

      public Date getToday()
      Liefert das Datum / Zeit des heutigen Tages zurück.
      Gibt zurück:
      Datum
      Seit:
      8.00.000

    • getYesterday

      public Date getYesterday()
      Liefert das Datum des gestrigen Tages zurück.
      Gibt zurück:
      Datum
      Seit:
      8.00.000

    • getTomorrow

      public Date getTomorrow()
      Liefert das Datum des nächsten Tages zurück.
      Gibt zurück:
      Datum
      Seit:
      8.00.000

    • isValidIsoDate

      public boolean isValidIsoDate(String isoDate)
      Meldet zurück, ob das angegebene Iso-Datum gültig ist.
      Parameter:
      isoDate - Iso-Datum
      Gibt zurück:
      Gültiges Iso-Datum
      Seit:
      8.00.000

    • isNewerThan

      public boolean isNewerThan(Date firstDate, Date secondDate)
      Meldet zurück, ob das erste Datum nach dem zweiten Datum liegt.
      Parameter:
      firstDate - Erstes Datum
      secondDate - Zweites Datum
      Gibt zurück:
      Bei true liegt das erste Datum nach dem zweiten Datum
      Seit:
      8.00.000

    • dateDiff

      public Date dateDiff(Date firstDate, int daysOffset)
      Addiert eine Anzahl von Tagen zu einem Datum.
      Parameter:
      firstDate - Startdatum
      daysOffset - Anzahl der Tage um die das Datum verschoben wird.
      Gibt zurück:
      Datum
      Seit:
      8.01.000

    • setObjKeyValue

      public void setObjKeyValue(Sord sord, int no, String value) throws Exception
      Setzt den Wert des angegebenen Indexfelds.
      Parameter:
      sord - Verschlagwortung
      no - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0
      value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.
      Löst aus:
      Exception - Wenn das Indexfeld nicht gefunden wird.
      Seit:
      8.01.004

    • setObjKeyValue

      public void setObjKeyValue(Sord sord, String name, String value) throws Exception
      Setzt den Wert des angegebenen Indexfelds.
      Parameter:
      sord - Verschlagwortung
      name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.
      value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.
      Löst aus:
      Exception - Wenn das Indexfeld nicht gefunden wird.
      Seit:
      8.01.004

    • getObjKeyValue

      public String getObjKeyValue(Sord sord, int no) throws Exception
      Liefert den Wert des angegeben Indexfelds zurück.
      Parameter:
      sord - Verschlagwortung
      no - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0
      Gibt zurück:
      Wert des Indexfelds. Falls ein Spaltenindex vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.
      Löst aus:
      Exception - Wenn das Indexfeld nicht gefunden wird.
      Seit:
      8.01.004

    • getObjKeyValue

      public String getObjKeyValue(Sord sord, String name) throws Exception
      Liefert den Wert des angegebenen Indexfelds zurück.
      Parameter:
      sord - Verschlagwortung
      name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.
      Gibt zurück:
      Wert des Indexfelds. Falls ein Spaltenindex vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.
      Löst aus:
      Exception - Wenn das Indexfeld nicht gefunden wird.
      Seit:
      8.01.004

    • getResource

      public String getResource(String bundleName, String resourceName, String locale)
      Liefert einen Text aus einem Resource Bundle zurück. Dabei kann optional ein locale Name angegeben werden. Wenn die null oder ein Leerstring ist, wird die default-Locale des Clients verwendet. Aufgrund der verwendeten internen Struktur ist die englische Übersetzung nicht über eine locale Einstellung erreichbar.
      Parameter:
      bundleName - Resource Bundle welches nach dem Text durchsucht werden soll.
      resourceName - Name der Text Resource
      locale - Optional, Name der Zielsprache, wenn null oder leer - default Sprache
      Gibt zurück:
      gesuchter Text
      Seit:
      8.03.000

    • getText

      public String getText(String ressourceName, String textID)
      Liefert einen Eintrag aus einer Text-Ressource-Datei für die aktuelle Sprache.
      Parameter:
      ressourceName - Bezeichnung der Ressource mit den Texten
      textID - Begriff
      Gibt zurück:
      Text-Eintrag oder textID, falls kein passender Eintrag gefunden wurde.
      Seit:
      8.03.000

    • createPdf

      public File createPdf(File file) throws Exception
      Erstellt eine PDF-Datei aus der angegebenen TIFF-Datei im temporären Java Client Verzeichnis.
      Parameter:
      file - TIFF-Datei
      Gibt zurück:
      File PDF-Datei oder null
      Löst aus:
      Exception - Wenn die Datei nicht konvertiert werden konnte.
      Seit:
      8.04.000

    • createHtmlUrl

      public File createHtmlUrl(String url, String title, String screenshot, boolean directLink) throws Exception
      Erstellt eine Html-Datei zur Ablage einer Url im temporären Java Client Verzeichnis.
      Parameter:
      url - Komplette URL, welche abgelegt werden soll
      title - Webseitentitel oder null für automatischen Titel
      screenshot - Pfad zu einem Screenshot oder data String eines Bildes oder null
      directLink - true überspringt Übersichtsseite bei der Vorschau und wechselt direkt auf die Webseite
      Gibt zurück:
      File Html-Datei oder null
      Löst aus:
      Exception - Wenn die Datei nicht erstellt werden konnte.
      Seit:
      12.00.000

    • joinFiles

      public File joinFiles(File firstFile, File secondFile) throws Exception
      Fügt zwei Dokumentendateien zusammen und gibt das Ergebnis in einer temporären Datei zurück.
      Parameter:
      firstFile - Erster Teil
      secondFile - Zweiter Teil
      Gibt zurück:
      Zieldatei im Temp-Ordner
      Löst aus:
      Exception - Wenn die Dateien nicht zusammengefasst werden konnten.
      Seit:
      8.05.000 Es werden nur TIFF Dokumente akzeptiert. Bei allen anderen Dateitypen gibt es ein undefiniertes Ergebnis., 9.01.000 geht jetzt auch mit PDF Files

    • readMail

      public MailItem readMail(File file)
      Liest eine E-Mail im MSG oder EML Format ein und gibt ein MailItem zurück
      Parameter:
      file - lokal gepeicherte E-Mail im MSG oder EML Format
      Gibt zurück:
      MailItem
      Seit:
      9.02.000

    • getExifTag

      public String getExifTag(File sourceFile, String tagName) throws Exception
      Liefert den Wert eines Exif Tags zurück.
      Parameter:
      sourceFile - Zu analysierende Tiff/ JPEG Datei
      tagName - Name des Exif Tags
      Gibt zurück:
      Wert des Exif Tags
      Löst aus:
      Exception - Wenn das Dokument nicht gelesen werden kann.
      Seit:
      10.00.000

    • getExifTagNames

      public Enumeration<String> getExifTagNames(File sourceFile) throws Exception
      Liefert die Liste Exif Tags zurück.
      Parameter:
      sourceFile - Zu analysierende Tiff/ JPEG Datei
      Gibt zurück:
      Enumeration der Exif Tag Namen
      Löst aus:
      Exception - Wenn das Dokument nicht gelesen werden kann.
      Seit:
      10.01.000

    • convertX400toSmtp

      public String convertX400toSmtp(String x400Address) throws Exception
      Wandelt eine X400 Adresse in eine SMTP Adresse um. Vorausgesetzt Outlook ist installiert und hat Zugriff auf den entsprechenden Exchange Server
      Parameter:
      x400Address - X400 Adresse
      Gibt zurück:
      SMTP Adresse
      Löst aus:
      Exception - Wenn nicht auf Outlook zugegriffen werden konnte oder die Adresse nicht aufgelöst werden kann.
      Seit:
      9.02.000

    • isValidEMailAddress

      public static boolean isValidEMailAddress(String mailAddress)
      Rudimentärer Test ob E-Mail Adresse gültig ist
      Parameter:
      mailAddress - Zu testende E-Mail Adresse
      Gibt zurück:
      ob E-Mail Adresse gültig ist
      Seit:
      9.02.000

    • createHtmlMail

      public boolean createHtmlMail(String recipient, String subject, String addToBody, File[] attachmentFiles)
      Erzeugt eine Mail für den Versand mit Empfänger (optional), Subject und html body Text sowie einer Dateiliste für die Attachments.
      Parameter:
      recipient - Empfänger
      subject - Betreff
      addToBody - Text, welcher an den Anfang des Mail-Bodys eingefügt wird.
      attachmentFiles - Anhänge
      Gibt zurück:
      true
      Seit:
      11.00.000

    • generateHtmlfromMail

      public File generateHtmlfromMail(File file) throws Exception
      Erzeugt eine HTML aus der eml/msg-Mail.
      Parameter:
      recipient - Empfänger
      subject - Betreff
      addToBody - Text, welcher an den Anfang des Mail-Bodys eingefügt wird.
      attachmentFiles - Anhänge
      Gibt zurück:
      true
      Löst aus:
      Exception
      Seit:
      12.20.000

    • resolve

      public String resolve(String sourceTemplate, Sord sourceData, Map<String,String> extraData, boolean escapeHtml)
      Löst die Platzhalter in einem vorgegebenen String gegen die Werte in dem übergebenen Sord Objekt oder der Map auf. Die Werte der Map haben Priorität über das Sord Objekt.
      Parameter:
      sourceTemplate - Text mit Platzhaltern
      sourceData - Sord
      extraData - Zusätzliche Daten, welche Platzhalter ersetzten.
      escapeHtml - Flag HTML escapen
      Gibt zurück:
      Text mit den ersetzten Werten

    • splitParams

      public Map<String,String> splitParams(String params)
      Löst den Parameter-String von der Dropzone in einzelne Map Einträge auf.
      Parameter:
      params - Parameter-String
      Gibt zurück:
      Key-Value Paare der Parameter
      Seit:
      11.00.000