Package de.elo.client.scripting.interfaces

Klasse BackgroundJob

Object

BackgroundJob

public class BackgroundJob
extends Object

Überschrift: BackgroundJob

Beschreibung: Ein Hintergrundprozess des Scripting.

Copyright: Copyright (c) ELO Digital Office GmbH 2015

Seit:

9.02.000

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
BackgroundJob(Workspace workspace, String jobTypeName, String backgroundFunction)	Interner Konstruktor

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addProtocolEntry(CONSTANTS.PROTOCOL_LEVEL level, String message)	Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
void	addProtocolEntry(CONSTANTS.PROTOCOL_LEVEL level, String message, int objId)	Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
boolean	isStopped()	Prüft nach, ob der Vorgang abgebrochen werden soll.
void	setFinished()	Setzt den Status des Vorgangs auf "Beendet".
void	setStatus(String detailText)	Setzt den Status, welcher als "Details" in der Prozessübersicht angezeigt wird.
void	showProtocol()	Öffnet einen Dialog zur Anzeige des Protokolls.
void	stop()	Sendet das Signal zum abbrechen des Vorgangs.

Von Klasse geerbte Methoden Object

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

Konstruktordetails

BackgroundJob

public BackgroundJob(Workspace workspace,
 String jobTypeName,
 String backgroundFunction)

Interner Konstruktor

Parameter:

workspace - Aktueller Arbeitsbereich

jobTypeName - Name des Hintergrundprozesses

backgroundFunction - Scripting-Funktion, welche im Hintergrund ausgeführt werden soll

Methodendetails

stop

public void stop()

Sendet das Signal zum abbrechen des Vorgangs.

setFinished

public void setFinished()

Setzt den Status des Vorgangs auf "Beendet". Der Eintrag in der Prozessübersicht wird entfernt, wenn kein Protokoll geschrieben wurde. Mit Protokoll bleibt er stehen, bis er manuell entfernt wird oder der Client beendet wird.

isStopped

public boolean isStopped()

Prüft nach, ob der Vorgang abgebrochen werden soll.

Gibt zurück:

True wenn der Vorgang abgebrochen werden soll, False sonst.

addProtocolEntry

public void addProtocolEntry(CONSTANTS.PROTOCOL_LEVEL level,
 String message)

Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.

Parameter:

level - Stufe mit welcher der Eintrag in das Protokoll geschrieben wird, siehe PROTOCOLL_LEVEL

message - Nachricht

addProtocolEntry

public void addProtocolEntry(CONSTANTS.PROTOCOL_LEVEL level,
 String message,
 int objId)

Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.

Parameter:

level - Stufe mit welcher der Eintrag in das Protokoll geschrieben wird, siehe PROTOCOL_LEVEL

message - Nachricht

objId - Objekt-ID, wenn es einen Bezug zu einem Archiveintrag gibt

showProtocol

public void showProtocol()

Öffnet einen Dialog zur Anzeige des Protokolls.

setStatus

public void setStatus(String detailText)

Setzt den Status, welcher als "Details" in der Prozessübersicht angezeigt wird.

Parameter:

detailText - Angezeigter Text