de.xima.fc.interfaces.processing

Interface IWorkflowProcessingContext

All Known Implementing Classes:

WorkflowProcessingContext

public interface IWorkflowProcessingContext

Author:

xima media GmbH, Dresden - mgu - 22.09.2014

Method Summary

Modifier and Type	Method and Description
void	addProcessingResult(Integer aktionsId, IProcessingResult value) neues Aktionsergebnisobjekt hinzuzufügen
IEntityContext	getEntityContext()
IFormDataAdapter	getFormDataAdapter()
IWorkflowProcessing	getProcessing()
Map<String,Serializable>	getSessionAttributeMap()
SessionAttributes	getSessionAttributes() Deprecated. will be removed!
File	getSourceDir(Aktion aktion) Verzeichnis in dem die Dateien abgelegt werden können, welche für die Verarbeitung in dieser Aktion erzeugt werden.
String	getSourceDirPath(Aktion aktion) Pfad zum temporären Ressourcen-Verzeichnis.
<E extends IAbstractDateiData> File	getSourceFile(Aktion aktion, IFileProviding<E> file) Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank.
File	getTargetDir(Aktion aktion) Verzeichnis in dem die Dateien abgelegt werden können, welche in dieser Aktion erzeugt werden.
String	getTargetDirPath(Aktion aktion) Pfad zum temporären Ziel-Verzeichnis.
String	getTempDirPath(Aktion aktion) Deprecated. use getTargetDirPath(Aktion)
Vorgang	getVorgang()
IXForm	getXForm()
IXFormRenderConfig	getXFormRenderConfig()
boolean	hasKey(int aktionsId) ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist
void	setVorgang(Vorgang vorgang)
void	shutdown() alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)
IProcessingResult	valueFor(int aktionsId) spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln
String	valueFor(int id, EProcessingResult eProcessingResult, int index, String value)

Method Detail

addProcessingResult

void addProcessingResult(Integer aktionsId,
                         IProcessingResult value)

neues Aktionsergebnisobjekt hinzuzufügen

Parameters:

aktionsId - - Id der Aktion zu welcher die Aktionsergebnisobjekte zugeordnet werden

value - - Value das eigentliche Aktionsergebnisobjekt das abgelegt werden soll

valueFor

IProcessingResult valueFor(int aktionsId)

spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln

Parameters:

aktionsId - - die Id der Aktion für die die Ergebnismenge ermittelt werden soll.

Returns:

Objekt, welches das Aktionsergebnis darstellt

getTempDirPath

@Deprecated
String getTempDirPath(Aktion aktion)
                           throws IOException

Deprecated. use getTargetDirPath(Aktion)

Throws:

IOException

getTargetDirPath

String getTargetDirPath(Aktion aktion)
                 throws IOException

Pfad zum temporären Ziel-Verzeichnis. @see getTargetDir(Aktion)

Parameters:

aktion - Aktion für die dieser Pfad ermittelt werden soll

Returns:

String Pfad auf das temporäre Ziel-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getTargetDir

File getTargetDir(Aktion aktion)
           throws IOException

Verzeichnis in dem die Dateien abgelegt werden können, welche in dieser Aktion erzeugt werden. Beim Schließen des Kontextes wird diese Verzeichnis gelöscht

Parameters:

aktion - Aktion für die dieses Verzeichnis ermittelt werden soll

Returns:

File das temporäre Ziel-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceDirPath

String getSourceDirPath(Aktion aktion)
                 throws IOException

Pfad zum temporären Ressourcen-Verzeichnis. @see getSourceDir(Aktion)

Parameters:

aktion - Aktion für die dieser Pfad ermittelt werden soll

Returns:

String Pfad auf das temporäre Ressourcen-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceDir

File getSourceDir(Aktion aktion)
           throws IOException

Verzeichnis in dem die Dateien abgelegt werden können, welche für die Verarbeitung in dieser Aktion erzeugt werden. Beim Schließen des Kontextes wird dieses Verzeichnis gelöscht

Parameters:

aktion - Aktion für die dieses Verzeichnis ermittelt werden soll

Returns:

File das temporäre Ressourcen-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceFile

<E extends IAbstractDateiData> File getSourceFile(Aktion aktion,
                                                  IFileProviding<E> file)
                                           throws IOException

Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank. Diese werden in das Verzeichnis getSourceDir(Aktion) abgelegt und werden entsprechend beim Schließen des Kontextes mit gelöscht.

Parameters:

aktion - Aktion die Aktion in welcher die Datei zur Verfügung gestellt werden soll

file - IFileProviding Die Entität dessen Datei ausgelesen werden soll

Returns:

File die temporär abgelegte Datei

Throws:

IOException - wenn Fehler beim Anlegen der Datei auftreten

shutdown

void shutdown()
       throws IOException

alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)

Throws:

IOException - - wenn ein Fehler beim Löschen des temporären Verzeichnisses auftritt

hasKey

boolean hasKey(int aktionsId)

ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist

Parameters:

aktionsId - - ID der Aktion, deren Existenz geprüft werden soll

Returns:

true wenn element vorhanden, ansonsten false

getXForm

IXForm getXForm()

getXFormRenderConfig

IXFormRenderConfig getXFormRenderConfig()

getVorgang

Vorgang getVorgang()

setVorgang

void setVorgang(Vorgang vorgang)

getFormDataAdapter

IFormDataAdapter getFormDataAdapter()

getEntityContext

IEntityContext getEntityContext()

getSessionAttributeMap

Map<String,Serializable> getSessionAttributeMap()

valueFor

String valueFor(int id,
                EProcessingResult eProcessingResult,
                int index,
                String value)

getProcessing

IWorkflowProcessing getProcessing()

getSessionAttributes

@Deprecated
SessionAttributes getSessionAttributes()

Deprecated. will be removed!