de.xima.fc.entities

Class Aktion

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.AbstractMandantDependentEntity

de.xima.fc.entities.Aktion

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, IIndexed, IMandantDependent, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

Direct Known Subclasses:

ExportAktionData

@Entity
public class Aktion
extends AbstractMandantDependentEntity
implements IIndexed, INameProviding, IDescriptionProviding, IUUIDEntity

Die Entität Aktion stellt eine vom Benutzer erstellte Aktion dar, die vor dem Wechsel eines Status durchgeführt wird. Aktionen sind immer an Bedingung geknüpft, welche festlegen ob die Aktion abgearbeitet wird oder nicht. Eine Aktion hat immer ein Objekt, welches das Interface IProcessing implementiert, verknüpft. Dieses Objekt beinhaltet die konkrete Abarbeitung. Für mehr Informationen siehe unter IProcessing

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_AKTIV
static String	ATTR_BEDINGUNG
static String	ATTR_FOLGE_AKTION Konstanter Wert, der den Namen des Attributes getFolgeAktion() enthält
static String	ATTR_NAME Deprecated. Use #INameProviding.ATTR_NAME
static String	ATTR_PROCESSING_TYPE
static String	ATTR_STATUS
static String	COL_UUID

Fields inherited from class de.xima.fc.entities.AbstractMandantDependentEntity

mandant

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.fc.entities.interfaces.IIndexed

ATTR_IDXNUM

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

COL_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, TYPE_NAME_UUID

Fields inherited from interface de.xima.fc.entities.interfaces.IMandantDependent

ATTR_MANDANT, COL_CLIENT_ID

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Constructor Summary

Constructors

Constructor and Description
Aktion()

Method Summary

Modifier and Type	Method and Description
Aktion	cloneBasics()
Bedingung	getBedingung() Diese Methode dient dazu, die Bedingung zur Ausführung der Aktion zu erhalten.
String	getBeschreibung()
Aktion	getFolgeAktion() Diese Methode dient dazu, die Folgeaktion dieser Aktion innerhalb der Workflowverarbeitung zu ermitteln.
Long	getId()
int	getIdxNum() Liefert den aktuellen Index dieses Elements in der Collection, der es zugeordnet ist.
String	getName() Diese Methode dient dazu, den Namen der Aktion zu liefern.
int	getNewIdxNum() Diese Methode dient dazu, den zukünftigen Indexwert zu ermitteln
IProcessing	getProcessing() Gets the processing of the action from the deserialized object
VerarbeitungsParameterMap	getProcessingParameterMap()
String	getProcessingParameters()
EVerarbeitungsTyp	getProcessingType()
IProcessingWrapper	getProcessingWrapper() Gets a Wrapper of the processing
Status	getStatus() Diese Methode dient dazu, den aktuell gesetzten Status der Aktion zu ermitteln
String	getUUID()
UUID	getUUIDObject()
EWeiterverarbeitung_Aktion	getWeiterverarbeitungBeiFehler() Diese Methode dient dazu, zu ermitteln, wie im Fehlerfall der Aktionsabarbeitung reagiert wird.
boolean	hasCondition()
boolean	isAktiv()
void	setAktiv(boolean aktiv)
void	setBedingung(Bedingung bedingung) Diese Methode dient dazu, die Bedingung zu setzen, die zur Ausführung der Aktion dient.
void	setBeschreibung(String beschreibung)
void	setFolgeAktion(Aktion folgeAktion) Diese Methode dient dazu, die Folgeaktion dieser Aktion für die Workflowverarbeitung festzulegen.
void	setIdxNum(int idxNum) Setzt den aktuellen Index dieses Elements in der Collection, der es zugeordnet ist.
void	setName(String name) Diese Methode dient dazu, den Name der Aktion zu setzen.
void	setNewIdxNum(int newIdxNum) Diese Methode dient dazu, den zukünftigen Indexwert zu setzen
void	setProcessing(IProcessing processing) Sets the object that will be serialized
void	setProcessingParameterMap(VerarbeitungsParameterMap paramMap)
void	setProcessingParameters(String processingParameters)
void	setProcessingType(EVerarbeitungsTyp processingType)
void	setProcessingWrapper(IProcessingWrapper processingWrapper) Sets the processing via the wrapper
void	setStatus(Status status) Diese Methode dient dazu, den Status der Aktion zu setzen.
void	setUUID(String uuid)
void	setUUIDObject(UUID uuid)
void	setWeiterverarbeitungBeiFehler(EWeiterverarbeitung_Aktion errorProceeding) Diese Methode dient dazu, die Art der Abarbeitung dieser Aktion innerhalb des Workflows festzulegen, wenn ein Fehler auftritt.
String	toString()

Methods inherited from class de.xima.fc.entities.AbstractMandantDependentEntity

getMandant, setMandant

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

getDescription

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted, setId

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ATTR_FOLGE_AKTION

public static final String ATTR_FOLGE_AKTION

Konstanter Wert, der den Namen des Attributes getFolgeAktion() enthält

See Also:

Constant Field Values

ATTR_NAME

@Deprecated
public static final String ATTR_NAME

Deprecated. Use #INameProviding.ATTR_NAME

See Also:

Constant Field Values

ATTR_STATUS

public static final String ATTR_STATUS

See Also:

Constant Field Values

ATTR_BEDINGUNG

public static final String ATTR_BEDINGUNG

See Also:

Constant Field Values

ATTR_AKTIV

public static final String ATTR_AKTIV

See Also:

Constant Field Values

ATTR_PROCESSING_TYPE

public static final String ATTR_PROCESSING_TYPE

See Also:

Constant Field Values

COL_UUID

public static final String COL_UUID

See Also:

Constant Field Values

Constructor Detail

Aktion

public Aktion()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

getUUID

public String getUUID()

Specified by:

getUUID in interface IUUIDEntity

Returns:

UUID (Universal Unique Identifier) that identifies this type of entity. Usually is unique within a context, e.g. Mandant, Projekt, ...

setUUID

public void setUUID(String uuid)

Specified by:

setUUID in interface IUUIDEntity

getUUIDObject

public UUID getUUIDObject()

Specified by:

getUUIDObject in interface IUUIDEntity

setUUIDObject

public void setUUIDObject(UUID uuid)

getStatus

public Status getStatus()

Diese Methode dient dazu, den aktuell gesetzten Status der Aktion zu ermitteln

Returns:

Status

setStatus

public void setStatus(Status status)

Diese Methode dient dazu, den Status der Aktion zu setzen.

Bedingung:

• nicht null

Parameters:

status - Status-Objekt auf das die Aktion gesetzt werden soll.

getName

public String getName()

Diese Methode dient dazu, den Namen der Aktion zu liefern.

Specified by:

getName in interface INameProviding

Returns:

Name der Aktion als Zeichenkette

setName

public void setName(String name)

Diese Methode dient dazu, den Name der Aktion zu setzen.

Bedingung:

• nicht null
• alphanumerische Zeichen und Leerzeichen: (?i)^[A-Z0-9 ]+$

Parameters:

name - Zeichenkette die den Namen angibt, den die Aktion tragen soll.

getIdxNum

public int getIdxNum()

Description copied from interface: IIndexed

Liefert den aktuellen Index dieses Elements in der Collection, der es zugeordnet ist.

Specified by:

getIdxNum in interface IIndexed

Returns:

Der numerische Index.

setIdxNum

public void setIdxNum(int idxNum)

Setzt den aktuellen Index dieses Elements in der Collection, der es zugeordnet ist.

Bedingung:

• >= 0

Specified by:

setIdxNum in interface IIndexed

Parameters:

idxNum - Der zu setzende Index.

getBedingung

public Bedingung getBedingung()

Diese Methode dient dazu, die Bedingung zur Ausführung der Aktion zu erhalten.

Returns:

Bedingung zu der Aktion

setBedingung

public void setBedingung(Bedingung bedingung)

Diese Methode dient dazu, die Bedingung zu setzen, die zur Ausführung der Aktion dient.

Bedingung:

• nicht null

Parameters:

bedingung - die für die Aktion gelten soll

getWeiterverarbeitungBeiFehler

public EWeiterverarbeitung_Aktion getWeiterverarbeitungBeiFehler()

Diese Methode dient dazu, zu ermitteln, wie im Fehlerfall der Aktionsabarbeitung reagiert wird.

Returns:

EWeiterverarbeitung_Aktion.ABBRUCH oder EWeiterverarbeitung_Aktion.KONFIGURIERTE_FOLGEAKTION

setWeiterverarbeitungBeiFehler

public void setWeiterverarbeitungBeiFehler(EWeiterverarbeitung_Aktion errorProceeding)

Diese Methode dient dazu, die Art der Abarbeitung dieser Aktion innerhalb des Workflows festzulegen, wenn ein Fehler auftritt.

Bedingung:

• nicht null

Parameters:

errorProceeding - EWeiterverarbeitung_Aktion.ABBRUCH oder EWeiterverarbeitung_Aktion.KONFIGURIERTE_FOLGEAKTION sind zulässige Werte

getFolgeAktion

public Aktion getFolgeAktion()

Diese Methode dient dazu, die Folgeaktion dieser Aktion innerhalb der Workflowverarbeitung zu ermitteln.

Returns:

Aktion oder null

setFolgeAktion

public void setFolgeAktion(Aktion folgeAktion)

Diese Methode dient dazu, die Folgeaktion dieser Aktion für die Workflowverarbeitung festzulegen.

Parameters:

folgeAktion - Aktion die als Folgeaktion gesetzt werden soll. Kann null sein

toString

public String toString()

Overrides:

toString in class AbstractLockableEntity

getNewIdxNum

public int getNewIdxNum()

Diese Methode dient dazu, den zukünftigen Indexwert zu ermitteln

Returns:

zukünftiger Indexwert

setNewIdxNum

public void setNewIdxNum(int newIdxNum)

Diese Methode dient dazu, den zukünftigen Indexwert zu setzen

Parameters:

newIdxNum - Zahlenwert

isAktiv

public boolean isAktiv()

setAktiv

public void setAktiv(boolean aktiv)

getBeschreibung

public String getBeschreibung()

Specified by:

getBeschreibung in interface IDescriptionProviding

setBeschreibung

public void setBeschreibung(String beschreibung)

getProcessingType

public EVerarbeitungsTyp getProcessingType()

setProcessingType

public void setProcessingType(EVerarbeitungsTyp processingType)

getProcessingParameters

public String getProcessingParameters()

setProcessingParameters

public void setProcessingParameters(String processingParameters)

getProcessing

public IProcessing getProcessing()

Gets the processing of the action from the deserialized object

Returns:

IProcessing of the action

setProcessing

public void setProcessing(IProcessing processing)

Sets the object that will be serialized

Parameters:

processing - IProcessing to set

getProcessingWrapper

public IProcessingWrapper getProcessingWrapper()

Gets a Wrapper of the processing

Returns:

IProcessingWrapper

setProcessingWrapper

public void setProcessingWrapper(IProcessingWrapper processingWrapper)

Sets the processing via the wrapper

Parameters:

processingWrapper - IProcessingWrapper

getProcessingParameterMap

public VerarbeitungsParameterMap getProcessingParameterMap()

setProcessingParameterMap

public void setProcessingParameterMap(VerarbeitungsParameterMap paramMap)

hasCondition

public boolean hasCondition()

cloneBasics

public Aktion cloneBasics()