Package de.xima.fc.entities

Class WorkflowNode

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.AWorkflowElement<WorkflowNode,WorkflowNodeSearchTerm>

de.xima.fc.entities.WorkflowNode

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, IActiveFlagProviding, ICustomParametersProviding, IElementKeyProviding, IElementSearchTermsProviding, IIdProviding<Long>, IUuidProviding, IVersionedCustomParametersProviding, IWorkflowElementEntity, IWorkflowElementTypeProviding, IWorkflowNodeTypeProviding, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class WorkflowNode
extends AWorkflowElement<WorkflowNode,WorkflowNodeSearchTerm>
implements IWorkflowNodeTypeProviding

A workflow node that represents a statement in a workflow task. Each node can be thought of as a statement node in the syntax tree of a structured program. The graph formed by the getParent() and getChildren() relations must be a tree.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CHILDREN	JPA attribute name for the getChildren() field.
static String	ATTR_PARENT	JPA attribute name for the getParent() field.
static String	COL_PARENT	Database column name for the getParent() field.
static String	COL_PARENT_ORDER_INDEX	The index at which this entity appear in getChildren().

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

active, ATTR_ACTIVE, ATTR_CUSTOM_PARAMETERS, ATTR_CUSTOM_PARAMETERS_VERSION, ATTR_DESCRIPTION, ATTR_SEARCH_TERMS, ATTR_TASK, ATTR_TYPE, COL_ACTIVE, COL_CUSTOM_PARAMETERS, COL_CUSTOM_PARAMETERS_VERSION, COL_DESCRIPTION, COL_NAME, COL_TASK, COL_TYPE, customParameters, customParametersVersion, description, name, searchTerms, task, type, uuid

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.IDescriptionProviding

ATTR_BESCHREIBUNG

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

ATTR_ID

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

ATTR_LOCKINGVERSION

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

ATTR_NAME

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

IMPORT_ID, INVALID_ID

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

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
WorkflowNode()

Method Summary

Modifier and Type	Method	Description
void	addChild(int index, WorkflowNode child)	Adds a child node to the tail of the existing children, and sets the parent of the given node to this node.
void	addChild(WorkflowNode child)	Adds a child node to the tail of the existing children, and sets the parent of the given node to this node.
List<WorkflowNode>	getChildren()
Long	getId()
ElementKey	getKey()
WorkflowNode	getParent()
List<WorkflowNodeSearchTerm>	getSearchTerms()
void	putSearchTerm(WorkflowNodeSearchTerm searchTerm)	Adds the given search term to this element, and sets AWorkflowElementSearchTerm.getElement() to this element.
void	setChildren(List<WorkflowNode> children)
void	setParent(WorkflowNode parent)
String	toString()

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

cloneBasics, getBeschreibung, getCustomParameters, getCustomParametersVersion, getDescription, getName, getTask, getType, getUuid, getUUID, getUUIDObject, isActive, setActive, setCustomParameters, setCustomParametersVersion, setDescription, setName, setSearchTerms, setTask, setType, setUUID, setUUIDObject

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 java.lang.Comparable

compareTo

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersProviding

getCustomParametersJson

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

isPersisted, setId

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementEntity

setCustomParametersJson

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding

getType

Field Detail

ATTR_CHILDREN

public static final String ATTR_CHILDREN

JPA attribute name for the getChildren() field.

See Also:

Constant Field Values

ATTR_PARENT

public static final String ATTR_PARENT

JPA attribute name for the getParent() field.

See Also:

Constant Field Values

COL_PARENT

public static final String COL_PARENT

Database column name for the getParent() field.

See Also:

Constant Field Values

COL_PARENT_ORDER_INDEX

public static final String COL_PARENT_ORDER_INDEX

The index at which this entity appear in getChildren().

See Also:

Constant Field Values

Constructor Detail

WorkflowNode

public WorkflowNode()

Method Detail

addChild

public void addChild(WorkflowNode child)

Adds a child node to the tail of the existing children, and sets the parent of the given node to this node.

Parameters:

child - The child node to add.

addChild

public void addChild(int index,
                     WorkflowNode child)

Adds a child node to the tail of the existing children, and sets the parent of the given node to this node.

Parameters:

index - Position at which to add the child. When smaller than 0, the (current length of the children + 1) is added (-1 appends the item to the end of the list, -2 inserts the item as the second to last position etc.). Afterwards the index is clamped to the range [0, children.size()], so that no index out of bound exceptions can occur.

child - The child node to add.

getChildren

public List<WorkflowNode> getChildren()

Returns:

A list of child nodes, i.e. the nodes that have this node set as their getParent(). Which and how many children a node must or can have depends on the AWorkflowElement.getType() of this node. See EWorkflowNodeKind for a list of built-in nodes.

See Also:

getParent()

getId

public Long getId()

Specified by:

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

Specified by:

getId in interface IIdProviding<Long>

Returns:

The ID that identifies this instance.

getKey

public ElementKey getKey()

Specified by:

getKey in interface IElementKeyProviding

Returns:

The key that identifies this instance.

getParent

public WorkflowNode getParent()

Returns:

The parent of this node, i.e. the node that contains this node in its getChildren(). The parent may be null if and only if it is the root node, i.e. the node pointed to by WorkflowTask.getRootNode().

See Also:

getChildren()

getSearchTerms

public List<WorkflowNodeSearchTerm> getSearchTerms()

Specified by:

getSearchTerms in interface IElementSearchTermsProviding

Returns:

The search terms that were defined for this workflow element.

putSearchTerm

public void putSearchTerm(WorkflowNodeSearchTerm searchTerm)

Adds the given search term to this element, and sets AWorkflowElementSearchTerm.getElement() to this element.

Parameters:

searchTerm - The search term to add to this element.

setChildren

public void setChildren(List<WorkflowNode> children)

Parameters:

children - A list of child nodes, i.e. the nodes that have this node set as their getParent(). Which and how many children a node must or can have depends on the AWorkflowElement.getType() of this node. See EWorkflowNodeKind for a list of built-in nodes.

See Also:

getParent()

setParent

public void setParent(WorkflowNode parent)

Parameters:

parent - The parent of this node, i.e. the node that contains this node in its getChildren(). The parent may be null if and only if it is the root node, i.e. the node pointed to by WorkflowTask.getRootNode().

toString

public String toString()

Overrides:

toString in class AbstractLockableEntity