de.elo.client.scripting.interfaces
Class UtilsAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.UtilsAdapter

public class UtilsAdapter
extends java.lang.Object

Überschrift: UtilsAdapter

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

Copyright: Copyright (c) ELO Digital Office GmbH 2011

Since:

8.00.000

Constructor Summary

UtilsAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

java.io.File	changeFileExtension(java.io.File file, java.lang.String newFileExt) Liefert eine Datei mit der neuen Dateiendung zurück.
boolean	copyFile(java.io.File sourceFile, java.io.File targetFile) Kopiert die angegebene Quelldatei in die angegebene Zieldatei und meldet das Ergebnis zurück.
java.util.Date	dateDiff(java.util.Date firstDate, int daysOffset) Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
java.util.Date	dateFromIso(java.lang.String isoDate) Konvertiert das angegebene Iso-Datum zu einem Java-Datum.
java.lang.String	displayDateFromIso(java.lang.String isoDate) Formatiert den angegebenen ISO-Datumsstring in eine Datumsanzeige um.
java.lang.String	displayDateFromIsoWithTime(java.lang.String isoDate) Formatiert einen ISO Datumsstring in eine Datumsanzeige um.
void	editFile(java.io.File file) Öffnet die Datei mit dem vom Betriebssystem dafür vorgesehenen Programm zur Bearbeitung.
int	eloDateFromJavaDate(java.util.Date date) Erzeugt aus dem angegebene Java-Datum ein ELO-Datum.
int	eloDateFromJavaDate(long date) Erzeugt aus dem angegebene Java-Datum ein ELO-Datum.
java.util.Date	getDateWithoutTime(java.util.Date date) Liefert das übergebene Datum ohne Uhrzeit zurück (0:00:00.000).
java.lang.String	getFileExtension(java.io.File file) Liefert die Dateiendung der angegebenen Datei zurück.
java.lang.String	getFileNameWithOption(de.elo.ix.client.Sord sord) Liefert den Dateinamen des angegebenen Archiveintrags unter Beachtung der ensprechenden Client-Option.
java.lang.String	getFileNameWithoutExtension(java.io.File file) Liefert den Dateinamen ohne die Dateiendung zurück.
java.util.Date	getNow(int offsetMinutes) Liefert ein Datum mit der aktuellen Uhrzeit und die addierten angegebenen Minuten zurück.
java.util.Date	getToday() Liefert das Datum / Zeit des heutigen Tages zurück.
java.util.Date	getTomorrow() Liefert das Datum des nächsten Tages zurück.
java.io.File	getUniqueFile(java.io.File directory, java.lang.String fileNameWithExtension) Liefert eine eindeutige Datei für den angegebenen Dateinamen in dem angegebenen Verzeichnis.
java.util.Date	getYesterday() Liefert das Datum des gestrigen Tages zurück.
boolean	isNewerThan(java.util.Date firstDate, java.util.Date secondDate) Meldet zurück, ob das erste Datum nach dem zweiten Datum liegt.
java.lang.String	isoFromDate(java.util.Date date) Konvertiert das angegebene Java-Datum nach einem Iso-Datum.
boolean	isValidIsoDate(java.lang.String isoDate) Meldet zurück, ob das angegebene Iso-Datum gültig ist.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilsAdapter

public UtilsAdapter(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

editFile

public void editFile(java.io.File file)
              throws java.lang.Exception

Öffnet die Datei mit dem vom Betriebssystem dafür vorgesehenen Programm zur Bearbeitung.

Parameters:

file - Zu öffnende Datei

Throws:

java.lang.Exception

Since:

8.00.000

getFileNameWithOption

public java.lang.String getFileNameWithOption(de.elo.ix.client.Sord sord)

Liefert den Dateinamen des angegebenen Archiveintrags unter Beachtung der ensprechenden Client-Option. Bei ungültiger Parameterangabe wird null zurückgeliefert.

Parameters:

sord - Archiveintrag

Returns:

Dateiname

Since:

8.00.000

getUniqueFile

public java.io.File getUniqueFile(java.io.File directory,
                                  java.lang.String fileNameWithExtension)

Liefert eine eindeutige Datei für den angegebenen Dateinamen in dem angegebenen Verzeichnis. Bei ungültiger Parameterangabe wird null zurückgeliefert.

Parameters:

directory - Verzeichnis, in dem die Datei erzeugt wird

fileNameWithExtension - Dateiname mit Dateiendung

Returns:

Eindeutige Datei oder null bei einem Fehler

Since:

8.00.000

copyFile

public boolean copyFile(java.io.File sourceFile,
                        java.io.File targetFile)

Kopiert die angegebene Quelldatei in die angegebene Zieldatei und meldet das Ergebnis zurück. Bei ungültigen Parameterangaben wird false zurückgegeben.

Parameters:

sourceFile - Quelldatei

targetFile - Zieldatei

Returns:

Kopierergebnis: True wenn kopiert wurden, False bei einem Fehler

Since:

8.00.000

getFileExtension

public java.lang.String getFileExtension(java.io.File file)

Liefert die Dateiendung der angegebenen Datei zurück. Bei ungültiger Parameterangabe wird null zurückgeliefert.

Parameters:

file - Datei

Returns:

Dateiendung oder null bei einem Fehler

Since:

8.00.000

getFileNameWithoutExtension

public java.lang.String getFileNameWithoutExtension(java.io.File file)

Liefert den Dateinamen ohne die Dateiendung zurück. Bei ungültiger Parameterangabe wird null zurückgeliefert.

Parameters:

file - Datei

Returns:

Dateiname ohne Dateiendung oder null bei einem Fehler

Since:

8.00.000

changeFileExtension

public java.io.File changeFileExtension(java.io.File file,
                                        java.lang.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ückgelifert.

Parameters:

file - Datei, deren Dateiendung geändert wird

newFileExt - Neue Dateiendung

Returns:

Neue Datei oder null bei einem Fehler

Since:

8.00.000

dateFromIso

public java.util.Date dateFromIso(java.lang.String isoDate)

Konvertiert das angegebene Iso-Datum zu einem Java-Datum. Bei ungültigen Parameterangaben wird null zurückgeliefert.

Parameters:

isoDate - Datum in ISO Schreibweise YYYYMMDDHHMMSS

Returns:

Java-Datum oder null bei einem Fehler

Since:

8.00.000

displayDateFromIso

public java.lang.String displayDateFromIso(java.lang.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.

Parameters:

isoDate - Datum in ISO Schreibweise YYYYMMDDHHMMSS

Returns:

Formatierte Datumsanzeige

Since:

8.00.000

displayDateFromIsoWithTime

public java.lang.String displayDateFromIsoWithTime(java.lang.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.

Parameters:

isoDate - Datum in ISO Schreibweise YYYYMMDD oder YYYYMMDDHHMMSS

Returns:

Formatierte Datumsanzeige

Since:

8.00.000

isoFromDate

public java.lang.String isoFromDate(java.util.Date date)

Konvertiert das angegebene Java-Datum nach einem Iso-Datum. Bei ungültigen Paramterangaben wird null zurückgeliefert.

Parameters:

date - Java-Datum

Returns:

Datum in ISO Schreibweise YYYYMMDDHHMMSS

Since:

8.00.000

eloDateFromJavaDate

public int eloDateFromJavaDate(java.util.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

Parameters:

date - Java-Datum

Returns:

ELO-Datum

Since:

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

Parameters:

date - Java-Datum

Returns:

ELO-Datum

Since:

8.00.000

getDateWithoutTime

public java.util.Date getDateWithoutTime(java.util.Date date)

Liefert das übergebene Datum ohne Uhrzeit zurück (0:00:00.000).

Parameters:

date - Java-Datum

Returns:

Java-Datum ohne Uhrzeit

Since:

8.00.000

getNow

public java.util.Date getNow(int offsetMinutes)

Liefert ein Datum mit der aktuellen Uhrzeit und die addierten angegebenen Minuten zurück.

Parameters:

offsetMinutes - Anzahl der Minuten, die zur aktuellen Zeit addiert werden

Returns:

Datum

Since:

8.00.000

getToday

public java.util.Date getToday()

Liefert das Datum / Zeit des heutigen Tages zurück.

Returns:

Datum

Since:

8.00.000

getYesterday

public java.util.Date getYesterday()

Liefert das Datum des gestrigen Tages zurück.

Returns:

Datum

Since:

8.00.000

getTomorrow

public java.util.Date getTomorrow()

Liefert das Datum des nächsten Tages zurück.

Returns:

Datum

Since:

8.00.000

isValidIsoDate

public boolean isValidIsoDate(java.lang.String isoDate)

Meldet zurück, ob das angegebene Iso-Datum gültig ist.

Parameters:

isoDate - Iso-Datum

Returns:

Gültiges Iso-Datum

Since:

8.00.000

isNewerThan

public boolean isNewerThan(java.util.Date firstDate,
                           java.util.Date secondDate)

Meldet zurück, ob das erste Datum nach dem zweiten Datum liegt.

Parameters:

firstDate - Erstes Datum

secondDate - Zweites Datum

Returns:

Bei true liegt das erste Datum nach dem zweiten Datum

Since:

8.00.000

dateDiff

public java.util.Date dateDiff(java.util.Date firstDate,
                               int daysOffset)

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Parameters:

firstDate -

daysOffset -

Returns:

Since:

8.01.000