de.elo.client.scripting.constants
Interface ScriptEvents

public interface ScriptEvents

Überschrift: ScriptEvents

Beschreibung: Ein ScriptEvent ist eine Konstante, welche bezeichnet, an welcher Stelle im Programmablauf des Client eine Script-Funktion mit welchen Parametern gestartet wird.

Copyright: Copyright (c) ELO Digital Office GmbH 2006-2012

Nested Class Summary

static class

ScriptEvents.SimpleScriptEvent Die einfachen Skript-Events haben keine Parameter.

Method Summary

void	eloInsertDocumentEnd(ArchiveDocument document) Nach dem Ablegen einer Datei als neues Dokument im Archiv.
int	eloInsertDocumentStart(java.lang.String mode, java.io.File file, int targetId) Vor dem Ablegen einer Datei als neues Dokument im Archiv.
void	eloMoveArchiveElementEnd(java.lang.String mode, ArchiveElement element, int parentId, int targetId) Nach dem Verschieben eines Eintrags im Archiv.
int	eloMoveArchiveElementStart(java.lang.String mode, ArchiveElement element, int parentId, int targetId) Vor dem Verschieben eines Eintrags im Archiv.

Method Detail

eloInsertDocumentStart

int eloInsertDocumentStart(java.lang.String mode,
                           java.io.File file,
                           int targetId)

Vor dem Ablegen einer Datei als neues Dokument im Archiv. Nach diesem Event kommen Dublettenkontrolle und (falls notwendig und konfiguriert) die "Verschlagwortung bei Bedarf".

Parameters:

mode - NORMAL: Ablage aus dem Dateisystem, z.B. per "Datei Einfügen"
DND: Ablage aus dem Dateisystem per Drag&Drop
INTRAY: Ablage einer Dokumentdatei aus der Postbox, z.B. per "Archivablage"
INTRAYDND: Ablage einer Dokumentdatei aus der Postbox per Drag&Drop
SCRIPTING: Ablage einer Dokumentdatei aus der Postbox per Internem Scripting
COMSERVER: Ablage einer Datei per Java Client COM-Server

file - Dokumentdatei, welche im Archiv ableget werden soll.

targetId - ObjektID des Zielordners im Archiv

Returns:

Bei einem negativen Rückgabewert wird der Ablegevorgang abgebrochen.

Since:

8.01.000

eloInsertDocumentEnd

void eloInsertDocumentEnd(ArchiveDocument document)

Nach dem Ablegen einer Datei als neues Dokument im Archiv.

Parameters:

document - Das neu angelegte Dokument im Archiv.

Since:

8.01.000

eloMoveArchiveElementStart

int eloMoveArchiveElementStart(java.lang.String mode,
                               ArchiveElement element,
                               int parentId,
                               int targetId)

Vor dem Verschieben eines Eintrags im Archiv.

Parameters:

mode - NORMAL: Verschieben per Funktion "Eintrag verschieben"
DND: Verschieben per Drag&Drop
UNDO: Verschieben als UNDO-Funktion
DELETE: Verschieben an Referenzposition beim Löschen
SCRIPTING: Verschieben per Internem Scripting

element - Der Archiveintrag.

parentId - Bisheriger Ordner in dem der Eintrag noch liegt.

targetId - Neuer Ordner in den der Eintrag verschoben werden soll.

Returns:

Bei einem negativen Rückgabewert wird das Verschieben abgebrochen.

Since:

8.01.000

eloMoveArchiveElementEnd

void eloMoveArchiveElementEnd(java.lang.String mode,
                              ArchiveElement element,
                              int parentId,
                              int targetId)

Nach dem Verschieben eines Eintrags im Archiv.

Parameters:

mode - siehe eloMoveArchiveElementStart

element - Der Archiveintrag.

parentId - Bisheriger Ordner in dem der Eintrag vorher lag.

targetId - Neuer Ordner in den der Eintrag verschoben wurde.

Since:

8.01.000