Package de.xima.fc.bl.fdv.processing

Class ProcessingWrapper

java.lang.Object

de.xima.fc.bl.fdv.processing.ProcessingWrapper

All Implemented Interfaces:

ITransferable, INamedUiElement, IProcessing, IProcessingWrapper, Serializable

public class ProcessingWrapper
extends Object
implements IProcessingWrapper

Wrapper class for workflow processing

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

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

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.interfaces.processing.IProcessing

ATTR_VERARBEITUNGSNAME

Constructor Summary

Constructors

Constructor	Description
ProcessingWrapper()

Method Summary

Modifier and Type	Method	Description
IProcessingResult	execute(IWorkflowProcessingContext wfpc, Aktion aktion)	Diese Methode dient dazu, die konkrete Aktionsverarbeitung zu implementieren.
List<Long>	getActionIds()	Deprecated.
String	getActionUUID()	Gets the UUID of the action that will be consumed by this action
List<String>	getActionUUIDs()	Gets the UUIDs of the actions that will be consumed by this action
List<Integer>	getAktionsIdErgebnisse()	Deprecated.
long	getDbConnectionId()
String	getDisplayName(Locale l)
IGuiIcon	getGuiIcon()
String	getIcon()	Deprecated.
List<org.json.JSONObject>	getParameters()
Map<String,String>	getParamMap()
Class<?>	getPluginClass(Mandant client)
long	getPostfachId()
String	getProcessingKey()
String	getProcessingName()	Diese Methode dient dazu, den Namen der Klasse zu repräsentierten, die der Client anfordern kann.
String	getProcessingPage()
String	getResource()	Deprecated.
ERessourcenTyp	getResourceType()	Gets the type of the resource that may be needed for processing
String	getResourceUri()	Gets the resource URI that may be needed for processing
String	getResourceUuid()	Gets the resource UUID that may be needed for processing
ERessourcenTyp	getRessTypeEnum()	Deprecated.
long	getSourceAktionId()	Deprecated.
String	getStateUUID()	Gets the UUID of the state that this processing is depending on
long	getStatusId()	Deprecated.
String	getTemplateUUID()	Gets the template UUID that may be needed for processing
long	getTextbausteinId()	Deprecated.
List<String>	getUploadElements()
boolean	isAttachToFormRecord()
boolean	isAvailable(IEntityContext ec, Mandant man)
boolean	isFileProviding()	Diese Methode dient dazu, anzugeben ob diese AktionsVerarbeitung eine erstellende Aktion ist.
boolean	isWrapperFor(Class<?> clazz)	Determines whether or not this instance is a wrapper for the given class
void	setActionIds(List<Long> actionIds)	Deprecated.
void	setActionUUID(String uuid)	Sets the UUID of the action that will be consumed by this action
void	setActionUUIDs(List<String> uuids)	Sets the UUIDs of the actions that will be consumed by this action
void	setAttachToFormRecord(boolean attachToFormRecord)	Sets whether or not files should be attached to the form record
void	setParameters(List<org.json.JSONObject> parameters)
void	setParamMap(Map<String,String> parameters)
void	setResource(String resource)	Deprecated.
void	setResourceUri(String uri)	Sets the resource URI that may be needed for processing
void	setResourceUuid(String uuid)	Sets the resource UUID that may be needed for processing
void	setSourceAktionId(long sourceAktionId)	Deprecated.
void	setStateUUID(String uuid)	Sets the UUID of the state that this processing is depending on
void	setTemplateUUID(String templateUUID)	Sets the template UUID that may be needed for processing
void	setUploadElements(List<String> uploadElements)	Sets the list of upload elements that should be used by this action
<T> T	unwrap(Class<T> clazz)	Unwraps the wrapped processing for the given class and returns it
void	wrapFor(Aktion action)	Wraps the action and its processing

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.processing.IProcessing

getAvailableOverrideValue, getLicenseKey, prefillProcessing

Constructor Detail

ProcessingWrapper

public ProcessingWrapper()

Method Detail

wrapFor

public void wrapFor(Aktion action)

Description copied from interface: IProcessingWrapper

Wraps the action and its processing

Specified by:

wrapFor in interface IProcessingWrapper

Parameters:

action - Aktion to wrap processing for

unwrap

public <T> T unwrap(Class<T> clazz)

Description copied from interface: IProcessingWrapper

Unwraps the wrapped processing for the given class and returns it

Specified by:

unwrap in interface IProcessingWrapper

Type Parameters:

T - Type to unrwap to

Parameters:

clazz - Class to unwrap for

Returns:

unwrapped processing

isWrapperFor

public boolean isWrapperFor(Class<?> clazz)

Description copied from interface: IProcessingWrapper

Determines whether or not this instance is a wrapper for the given class

Specified by:

isWrapperFor in interface IProcessingWrapper

Parameters:

clazz - Class to check

Returns:

true if the wrapped processing is assignable from the given class

getTemplateUUID

public String getTemplateUUID()

Gets the template UUID that may be needed for processing

Specified by:

getTemplateUUID in interface IProcessingWrapper

Returns:

String UUID of Textbaustein

setTemplateUUID

public void setTemplateUUID(String templateUUID)

Sets the template UUID that may be needed for processing

Specified by:

setTemplateUUID in interface IProcessingWrapper

Parameters:

templateUUID - String UUID of Textbaustein

getResourceUuid

public String getResourceUuid()

Gets the resource UUID that may be needed for processing

Specified by:

getResourceUuid in interface IProcessingWrapper

Returns:

String UUID of the resource

setResourceUuid

public void setResourceUuid(String uuid)

Sets the resource UUID that may be needed for processing

Specified by:

setResourceUuid in interface IProcessingWrapper

Parameters:

uuid - String UUID of the resource

getResourceUri

public String getResourceUri()

Gets the resource URI that may be needed for processing

Specified by:

getResourceUri in interface IProcessingWrapper

Returns:

String URI of the resource

setResourceUri

public void setResourceUri(String uri)

Sets the resource URI that may be needed for processing

Specified by:

setResourceUri in interface IProcessingWrapper

Parameters:

uri - String URI of the resource

getResourceType

public ERessourcenTyp getResourceType()

Gets the type of the resource that may be needed for processing

Specified by:

getResourceType in interface IProcessingWrapper

Returns:

ERessourcenTyp resource type

getActionUUIDs

public List<String> getActionUUIDs()

Description copied from interface: IProcessingWrapper

Gets the UUIDs of the actions that will be consumed by this action

Specified by:

getActionUUIDs in interface IProcessingWrapper

Returns:

List of Aktion.getUUID()s

setActionUUIDs

public void setActionUUIDs(List<String> uuids)

Description copied from interface: IProcessingWrapper

Sets the UUIDs of the actions that will be consumed by this action

Specified by:

setActionUUIDs in interface IProcessingWrapper

Parameters:

uuids - List of Aktion.getUUID()s

getStateUUID

public String getStateUUID()

Description copied from interface: IProcessingWrapper

Gets the UUID of the state that this processing is depending on

Specified by:

getStateUUID in interface IProcessingWrapper

Returns:

String UUID of the state that this processing is depending on

setStateUUID

public void setStateUUID(String uuid)

Description copied from interface: IProcessingWrapper

Sets the UUID of the state that this processing is depending on

Specified by:

setStateUUID in interface IProcessingWrapper

Parameters:

uuid - String UUID of the state that this processing is depending on

getActionUUID

public String getActionUUID()

Description copied from interface: IProcessingWrapper

Gets the UUID of the action that will be consumed by this action

Specified by:

getActionUUID in interface IProcessingWrapper

Returns:

Aktion.getUUID()

setActionUUID

public void setActionUUID(String uuid)

Description copied from interface: IProcessingWrapper

Sets the UUID of the action that will be consumed by this action

Specified by:

setActionUUID in interface IProcessingWrapper

Parameters:

uuid - Aktion.getUUID()

getDbConnectionId

public long getDbConnectionId()

Specified by:

getDbConnectionId in interface IProcessingWrapper

Returns:

Long ID of the DB connection used by this action

getUploadElements

public List<String> getUploadElements()

Specified by:

getUploadElements in interface IProcessingWrapper

Returns:

List of upload elements used by this action

setUploadElements

public void setUploadElements(List<String> uploadElements)

Description copied from interface: IProcessingWrapper

Sets the list of upload elements that should be used by this action

Specified by:

setUploadElements in interface IProcessingWrapper

Parameters:

uploadElements - List of upload elements

isAttachToFormRecord

public boolean isAttachToFormRecord()

Specified by:

isAttachToFormRecord in interface IProcessingWrapper

Returns:

Boolean whether or not files should be attached to the form record

setAttachToFormRecord

public void setAttachToFormRecord(boolean attachToFormRecord)

Description copied from interface: IProcessingWrapper

Sets whether or not files should be attached to the form record

Specified by:

setAttachToFormRecord in interface IProcessingWrapper

Parameters:

attachToFormRecord - Boolean

getPostfachId

public long getPostfachId()

Specified by:

getPostfachId in interface IProcessingWrapper

Returns:

Long the inbox id being used by this action

getPluginClass

public Class<?> getPluginClass(Mandant client)

Specified by:

getPluginClass in interface IProcessingWrapper

getParameters

public List<org.json.JSONObject> getParameters()

Specified by:

getParameters in interface IProcessingWrapper

setParameters

public void setParameters(List<org.json.JSONObject> parameters)

Specified by:

setParameters in interface IProcessingWrapper

getParamMap

public Map<String,String> getParamMap()

Specified by:

getParamMap in interface IProcessingWrapper

setParamMap

public void setParamMap(Map<String,String> parameters)

Specified by:

setParamMap in interface IProcessingWrapper

getProcessingName

public String getProcessingName()

Description copied from interface: IProcessing

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

Specified by:

getProcessingName in interface IProcessing

Returns:

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

isFileProviding

public boolean isFileProviding()

Description copied from interface: IProcessing

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

Specified by:

isFileProviding in interface IProcessing

Returns:

true, wenn die Aktion eine Datei bereitstellt

getProcessingKey

public String getProcessingKey()

Specified by:

getProcessingKey in interface IProcessing

getProcessingPage

public String getProcessingPage()

Specified by:

getProcessingPage in interface IProcessing

getGuiIcon

public IGuiIcon getGuiIcon()

Specified by:

getGuiIcon in interface IProcessing

getDisplayName

public String getDisplayName(Locale l)

Specified by:

getDisplayName in interface INamedUiElement

Returns:

Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).

execute

public IProcessingResult execute(IWorkflowProcessingContext wfpc,
                                 Aktion aktion)
                          throws WorkflowProcessingException

Description copied from interface: IProcessing

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");
 

Specified by:

execute in interface IProcessing

Parameters:

wfpc - the current IWorkflowProcessingContext

aktion - the current Aktion

Throws:

WorkflowProcessingException - wenn ein Fehler in der konkreten Verarbeitung auftritt

getTextbausteinId

@Deprecated
public long getTextbausteinId()

Deprecated.

Specified by:

getTextbausteinId in interface IProcessingWrapper

getActionIds

@Deprecated
public List<Long> getActionIds()

Deprecated.

Specified by:

getActionIds in interface IProcessingWrapper

setActionIds

@Deprecated
public void setActionIds(List<Long> actionIds)

Deprecated.

Specified by:

setActionIds in interface IProcessingWrapper

getAktionsIdErgebnisse

@Deprecated
public List<Integer> getAktionsIdErgebnisse()

Deprecated.

Specified by:

getAktionsIdErgebnisse in interface IProcessingWrapper

getStatusId

@Deprecated
public long getStatusId()

Deprecated.

Specified by:

getStatusId in interface IProcessingWrapper

getSourceAktionId

@Deprecated
public long getSourceAktionId()

Deprecated.

Specified by:

getSourceAktionId in interface IProcessingWrapper

setSourceAktionId

@Deprecated
public void setSourceAktionId(long sourceAktionId)

Deprecated.

Specified by:

setSourceAktionId in interface IProcessingWrapper

setResource

@Deprecated
public void setResource(String resource)

Deprecated.

Specified by:

setResource in interface IProcessingWrapper

getResource

@Deprecated
public String getResource()

Deprecated.

Specified by:

getResource in interface IProcessingWrapper

getRessTypeEnum

@Deprecated
public ERessourcenTyp getRessTypeEnum()

Deprecated.

Specified by:

getRessTypeEnum in interface IProcessingWrapper

getIcon

@Deprecated
public String getIcon()

Deprecated.

Specified by:

getIcon in interface IProcessing

Returns:

The icon ID for this action.

isAvailable

public boolean isAvailable(IEntityContext ec,
                           Mandant man)

Specified by:

isAvailable in interface IProcessing