de.xima.fc.interfaces.processing

Interface IProcessing

All Superinterfaces:

INamedUiElement, ITransferable, Serializable

All Known Subinterfaces:

IDatabaseAccessDependent, IInboxDependent, IMailDependent, IProcessingPlugin, IStatusDependent, ITemplateDependent

All Known Implementing Classes:

AParameterVerarbeitung, AVerarbeitung, VerarbeitungCallback, VerarbeitungChangeStatus, VerarbeitungCompressAsZip, VerarbeitungCopyToPostfach, VerarbeitungCopyToStatus, VerarbeitungDbSQLQuery, VerarbeitungDeleteVorgang, VerarbeitungEmail, VerarbeitungExport, VerarbeitungExportPersistence, VerarbeitungExterneRessource, VerarbeitungInbox, VerarbeitungMoveToPostfach, VerarbeitungPdf, VerarbeitungPlugin, VerarbeitungPost, VerarbeitungRenewProzessID, VerarbeitungReturnFile, VerarbeitungSaveToFilesystem, VerarbeitungSendToSalesforce, VerarbeitungStop, VerarbeitungTemplate, VerarbeitungUpload, VerarbeitungWeiterleitung, VerarbeitungWord, VerarbeitungWriteToFile, VerarbeitungWriteToForm, VerarbeitungXmlToFd

public interface IProcessing
extends INamedUiElement, ITransferable

Dieses Interface muss von konkreten Aktionsverarbeitungen realisiert werden. All diese Aktionsverarbeitungsklassen müssen eine execute(...)-Methode aufweisen, welche die konkrete Abarbeitung implementiert. Zudem muss eine Methode vorhanden sein, die den Namen der Verarbeitungsklasse wiederspiegelt, damit diese vom Frontend aufgerufen werden können. Durch das Interface INamedUiElement soll gewährleistet werden, dass ein Anzeigename für das Frontend definiert wurde.

Author:

xima media GmbH, Dresden - 20.06.2011 - mgu

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_VERARBEITUNGSNAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method and Description
IProcessingResult	execute(IWorkflowProcessingContext wfpc, Aktion aktion) Diese Methode dient dazu, die konkrete Aktionsverarbeitung zu implementieren.
default Boolean	getAvailableOverrideValue()
IGuiIcon	getGuiIcon()
String	getIcon() Deprecated. This methods does not make it clear which icon font is to be used. Use getGuiIcon() instead.
String	getProcessingKey()
String	getProcessingName() Diese Methode dient dazu, den Namen der Klasse zu repräsentierten, die der Client anfordern kann.
String	getProcessingPage()
default boolean	isAvailable(IEntityContext ec, Mandant man)
boolean	isFileProviding() Diese Methode dient dazu, anzugeben ob diese AktionsVerarbeitung eine erstellende Aktion ist.
default void	prefillProcessing(IProcessingPrefillData prefillData) Method which is called the processing is created

Methods inherited from interface de.xima.fc.interfaces.INamedUiElement

getDisplayName

Field Detail

ATTR_VERARBEITUNGSNAME

static final String ATTR_VERARBEITUNGSNAME

See Also:

Constant Field Values

Method Detail

execute

IProcessingResult execute(IWorkflowProcessingContext wfpc,
                          Aktion aktion)
                   throws WorkflowProcessingException

Diese Methode dient dazu, die konkrete Aktionsverarbeitung zu implementieren. Diese Methode kann Dateien und Werte erzeugen, die für andere Aktionen zugänglich sein sollen. Hierzu kann der de.xima.fc.bl.fdv.WorkflowProcessingContext genutzt werden. Ein solcher WorkflowProcessingContext ist zugreifbar über den de.xima.fc.bl.fdv.WorkflowProcessingContextManager. Beispiel für die Nutzung des WorkflowProcessingContextManager:

 WorkflowProcessingContext processingContext = WorkflowProcessingContextManager.getInstance().getContext(v);
 List<Object> values = processingContext.allValues(aktionIdErgebnis);
 Object value = processingContext.valuesByKey(aktionIdErgebnis, "key");
 

Parameters:

workflowProcessingContext - TODO

aktionInProcess -

Throws:

WorkflowProcessingException - wenn ein Fehler in der konkreten Verarbeitung auftritt

getProcessingName

String getProcessingName()

Diese Methode dient dazu, den Namen der Klasse zu repräsentierten, die der Client anfordern kann.

Returns:

Zeichenkette mit dem Namen der Klasse: (this.getClass().getCanonicalName())

isFileProviding

boolean isFileProviding()

Diese Methode dient dazu, anzugeben ob diese AktionsVerarbeitung eine erstellende Aktion ist.

Returns:

true, wenn die Aktion eine Datei bereitstellt

getProcessingKey

String getProcessingKey()

getProcessingPage

String getProcessingPage()

getIcon

@Deprecated
String getIcon()

Deprecated. This methods does not make it clear which icon font is to be used. Use getGuiIcon() instead.

Returns:

The icon ID for this action.

getGuiIcon

IGuiIcon getGuiIcon()

getAvailableOverrideValue

default Boolean getAvailableOverrideValue()

isAvailable

default boolean isAvailable(IEntityContext ec,
                            Mandant man)

prefillProcessing

default void prefillProcessing(IProcessingPrefillData prefillData)

Method which is called the processing is created

Parameters:

prefillData - IProcessingPrefillData