org.kuali.rice.kew.engine.node
Class RouteNode

java.lang.Object
  org.kuali.rice.kew.engine.node.RouteNode

All Implemented Interfaces:

Serializable, Identifiable, Versioned, RouteNodeContract

Direct Known Subclasses:

RuleQuickLinksAction.RouteNodeForDisplay

@Entity
public class RouteNode
extends Object
implements Serializable, RouteNodeContract

Represents the prototype definition of a node in the route path of DocumentType.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

private String	activationType
private BranchPrototype	branch
private List<RouteNodeConfigParam>	configParams
static String	CONTENT_FRAGMENT_CFG_KEY
private DocumentType	documentType
private String	documentTypeId
private String	exceptionWorkgroupId
private String	exceptionWorkgroupName
private Boolean	finalApprovalInd
private Integer	lockVerNbr
private Boolean	mandatoryRouteInd
private String	nextDocStatus The nextDocStatus property represents the value of the ApplicationDocumentStatus to be set in the RouteHeader upon transitioning from this node.
private List<RouteNode>	nextNodes
private String	nodeType
private List<RouteNode>	previousNodes
private String	routeMethodCode
private String	routeMethodName
private String	routeNodeId
private String	routeNodeName
static String	RULE_SELECTOR_CFG_KEY
private RuleTemplate	ruleTemplate
private static long	serialVersionUID

Constructor Summary

RouteNode()

Method Summary

void	addNextNode(RouteNode nextNode)
void	beforeInsert()
String	getActivationType()
BranchPrototype	getBranch()
String	getBranchName()
protected RouteNodeConfigParam	getConfigParam(String key) Looks up a config parameter for this route node definition
List<RouteNodeConfigParam>	getConfigParams()
List<? extends RouteNodeConfigurationParameterContract>	getConfigurationParameters()
String	getContentFragment()
DocumentType	getDocumentType()
String	getDocumentTypeId()
String	getExceptionGroupId()
Group	getExceptionWorkgroup()
String	getExceptionWorkgroupId()
String	getExceptionWorkgroupName()
Boolean	getFinalApprovalInd()
String	getId() The unique identifier for an object.
Integer	getLockVerNbr()
Boolean	getMandatoryRouteInd()
String	getName()
String	getNextDocStatus()
String	getNextDocumentStatus()
List<String>	getNextNodeIds()
List<RouteNode>	getNextNodes()
String	getNodeType()
List<String>	getPreviousNodeIds()
List<RouteNode>	getPreviousNodes()
String	getRouteMethodCode()
String	getRouteMethodName()
String	getRouteNodeId()
String	getRouteNodeName()
RuleTemplate	getRuleTemplate()
String	getType()
Long	getVersionNumber() Returns the version number for this object.
boolean	isExceptionGroupDefined()
boolean	isFinalApproval()
boolean	isFlexRM()
boolean	isMandatory()
boolean	isRoleNode()
void	setActivationType(String activationType)
void	setBranch(BranchPrototype branch)
protected void	setConfigParam(String key, String value) Sets a config parameter for this route node definition.
void	setConfigParams(List<RouteNodeConfigParam> configParams)
void	setContentFragment(String contentFragment)
void	setDocumentType(DocumentType documentType)
void	setDocumentTypeId(String documentTypeId)
void	setExceptionWorkgroupId(String workgroupId)
void	setExceptionWorkgroupName(String exceptionWorkgroupName)
void	setFinalApprovalInd(Boolean finalApprovalInd)
void	setLockVerNbr(Integer lockVerNbr)
void	setMandatoryRouteInd(Boolean mandatoryRouteInd)
void	setNextDocStatus(String nextDocStatus)
void	setNextNodes(List<RouteNode> nextNodes)
void	setNodeType(String nodeType)
void	setPreviousNodes(List<RouteNode> parentNodes)
void	setRouteMethodCode(String routeMethodCode)
void	setRouteMethodName(String routeMethodName)
void	setRouteNodeId(String routeNodeId)
void	setRouteNodeName(String routeLevelName)
String	toString() This overridden method ...

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

CONTENT_FRAGMENT_CFG_KEY

public static final String CONTENT_FRAGMENT_CFG_KEY

See Also:

Constant Field Values

RULE_SELECTOR_CFG_KEY

public static final String RULE_SELECTOR_CFG_KEY

See Also:

Constant Field Values

routeNodeId

private String routeNodeId

documentTypeId

private String documentTypeId

routeNodeName

private String routeNodeName

routeMethodName

private String routeMethodName

finalApprovalInd

private Boolean finalApprovalInd

mandatoryRouteInd

private Boolean mandatoryRouteInd

exceptionWorkgroupId

private String exceptionWorkgroupId

routeMethodCode

private String routeMethodCode

activationType

private String activationType

nextDocStatus

private String nextDocStatus

The nextDocStatus property represents the value of the ApplicationDocumentStatus to be set in the RouteHeader upon transitioning from this node.

lockVerNbr

private Integer lockVerNbr

documentType

private DocumentType documentType

exceptionWorkgroupName

private String exceptionWorkgroupName

ruleTemplate

private RuleTemplate ruleTemplate

nodeType

private String nodeType

previousNodes

private List<RouteNode> previousNodes

nextNodes

private List<RouteNode> nextNodes

branch

private BranchPrototype branch

configParams

private List<RouteNodeConfigParam> configParams

Constructor Detail

RouteNode

public RouteNode()

Method Detail

getConfigParam

protected RouteNodeConfigParam getConfigParam(String key)

Looks up a config parameter for this route node definition

Parameters:

key - the config param key

Returns:

the RouteNodeConfigParam if present

setConfigParam

protected void setConfigParam(String key,
                              String value)

Sets a config parameter for this route node definition. If the key already exists the existing RouteNodeConfigParam is modified, otherwise a new one is created

Parameters:

key - the key of the parameter to set

value - the value to set

getConfigParams

public List<RouteNodeConfigParam> getConfigParams()

setConfigParams

public void setConfigParams(List<RouteNodeConfigParam> configParams)

getContentFragment

public String getContentFragment()

Returns:

the RouteNodeConfigParam value under the 'contentFragment' key

setContentFragment

public void setContentFragment(String contentFragment)

Parameters:

contentFragment - the content fragment of the node, which will be set as a RouteNodeConfigParam under the 'contentFragment' key

getActivationType

public String getActivationType()

Specified by:

getActivationType in interface RouteNodeContract

setActivationType

public void setActivationType(String activationType)

getExceptionWorkgroup

public Group getExceptionWorkgroup()

isExceptionGroupDefined

public boolean isExceptionGroupDefined()

getExceptionWorkgroupId

public String getExceptionWorkgroupId()

setExceptionWorkgroupId

public void setExceptionWorkgroupId(String workgroupId)

setFinalApprovalInd

public void setFinalApprovalInd(Boolean finalApprovalInd)

setMandatoryRouteInd

public void setMandatoryRouteInd(Boolean mandatoryRouteInd)

getRouteMethodName

public String getRouteMethodName()

Specified by:

getRouteMethodName in interface RouteNodeContract

setRouteMethodName

public void setRouteMethodName(String routeMethodName)

getDocumentTypeId

public String getDocumentTypeId()

Specified by:

getDocumentTypeId in interface RouteNodeContract

setDocumentTypeId

public void setDocumentTypeId(String documentTypeId)

getRouteNodeId

public String getRouteNodeId()

setRouteNodeId

public void setRouteNodeId(String routeNodeId)

getRouteNodeName

public String getRouteNodeName()

setRouteNodeName

public void setRouteNodeName(String routeLevelName)

getDocumentType

public DocumentType getDocumentType()

setDocumentType

public void setDocumentType(DocumentType documentType)

getRouteMethodCode

public String getRouteMethodCode()

Specified by:

getRouteMethodCode in interface RouteNodeContract

setRouteMethodCode

public void setRouteMethodCode(String routeMethodCode)

setNextDocStatus

public void setNextDocStatus(String nextDocStatus)

Parameters:

nextDocStatus - the nextDocStatus to set

getNextDocStatus

public String getNextDocStatus()

Returns:

the nextDocStatus

getExceptionWorkgroupName

public String getExceptionWorkgroupName()

setExceptionWorkgroupName

public void setExceptionWorkgroupName(String exceptionWorkgroupName)

getLockVerNbr

public Integer getLockVerNbr()

setLockVerNbr

public void setLockVerNbr(Integer lockVerNbr)

isFlexRM

public boolean isFlexRM()

isRoleNode

public boolean isRoleNode()

getFinalApprovalInd

public Boolean getFinalApprovalInd()

getMandatoryRouteInd

public Boolean getMandatoryRouteInd()

addNextNode

public void addNextNode(RouteNode nextNode)

getNextNodes

public List<RouteNode> getNextNodes()

setNextNodes

public void setNextNodes(List<RouteNode> nextNodes)

getPreviousNodes

public List<RouteNode> getPreviousNodes()

setPreviousNodes

public void setPreviousNodes(List<RouteNode> parentNodes)

getRuleTemplate

public RuleTemplate getRuleTemplate()

getNodeType

public String getNodeType()

setNodeType

public void setNodeType(String nodeType)

getBranch

public BranchPrototype getBranch()

setBranch

public void setBranch(BranchPrototype branch)

beforeInsert

public void beforeInsert()

toString

public String toString()

This overridden method ...

Overrides:

toString in class Object

See Also:

Object.toString()

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getName

public String getName()

Specified by:

getName in interface RouteNodeContract

isFinalApproval

public boolean isFinalApproval()

Specified by:

isFinalApproval in interface RouteNodeContract

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface RouteNodeContract

getExceptionGroupId

public String getExceptionGroupId()

Specified by:

getExceptionGroupId in interface RouteNodeContract

getType

public String getType()

Specified by:

getType in interface RouteNodeContract

getBranchName

public String getBranchName()

Specified by:

getBranchName in interface RouteNodeContract

getNextDocumentStatus

public String getNextDocumentStatus()

Specified by:

getNextDocumentStatus in interface RouteNodeContract

getConfigurationParameters

public List<? extends RouteNodeConfigurationParameterContract> getConfigurationParameters()

Specified by:

getConfigurationParameters in interface RouteNodeContract

getPreviousNodeIds

public List<String> getPreviousNodeIds()

Specified by:

getPreviousNodeIds in interface RouteNodeContract

getNextNodeIds

public List<String> getNextNodeIds()

Specified by:

getNextNodeIds in interface RouteNodeContract