public abstract class AbstractProcessNode extends java.lang.Object implements AppianTypeHolder, JSONCacheable
ProcessModel
. The node contains the primary
activity, which is its defining characteristic, as well as any pre- and
post-activities that the designer has configured. Attended nodes are
assigned to users, and are represented as tasks in the task list at
runtime. Each node also potentially contains one or many flows (or
connections), which are transitions to other nodes that can be traversed
once this node is completed.Modifier and Type | Field and Description |
---|---|
static java.lang.Float |
DEFAULT_COMPLETION
The default time, in days, in which each node should complete.
|
static java.lang.Float |
DEFAULT_LAG
The default log, in days, in which ecah node should complete.
|
hiddenAttributes$TRANSIENT
Constructor and Description |
---|
AbstractProcessNode() |
Modifier and Type | Method and Description |
---|---|
void |
fillInAppianTypes(AppianTypeCache cache_)
Adds the primary keys of any Appian-typed objects that are used by the
activites or escalations of this node to the given cache.
|
ActivityClass |
getActivityClass()
Gets the primary activity class associated with this node.
|
Assignment |
getAssign()
If this node has an attended primary activity, this method gets the
people, groups, etc.
|
Connection[] |
getAssociations() |
Attachment[] |
getAttachments()
Gets the attachments that have been attached to this node.
|
java.lang.String |
getConfirmationUrl()
Gets the URL to which the runtime user should be forwarded after
successfully completing the activity associated with this node.
|
Connection[] |
getConnections()
Gets the collection of flows representing connections to other nodes.
|
Deadline |
getDeadline() |
Security |
getDefaultNodeInstanceSecurity()
Gets the default security mapping for instances of this node.
|
LocaleString |
getDescription()
Gets the localized description mappings of this node.
|
LocaleString |
getDisplay()
Returns the task display name for this node.
|
protected abstract AbstractEscalation[] |
getEscalationAbstraction() |
EventProducer[] |
getEventProducers()
Gets the event producers for this node
|
Connection |
getExceptionFlow() |
EventTrigger[] |
getExceptionFlowTriggers()
Gets the triggers that can trigger an exception flow
|
LocaleString |
getFriendlyName()
Returns the name of this node.
|
Identity |
getGroupOwner()
Gets the group that owns this process node.
|
java.lang.Long |
getGroupOwnerId()
Gets the group that owns this node.
|
java.lang.String |
getGroupOwnerName()
Gets the name of the group that owns this node.
|
java.lang.Long |
getGuiId()
Gets the
guiId of this node. |
java.util.HashSet |
getHiddenAttributes()
Returns the set of attributes (properties) that should not be included in
the JSON representation of the object.
|
java.lang.Long |
getIcon()
Gets the id of the icon of the process node.
|
java.lang.Long |
getId()
Gets the primary key of this node.
|
Label |
getLabelStyle()
Gets the styling bean for this node's label.
|
java.lang.Long |
getLane()
Gets the index of the
Lane in which this node
is contained. |
MultipleInstance |
getMultipleInstance()
Returns the multiple instance configuration of the node.
|
Note[] |
getNotes()
Gets the notes that have been attached to this node.
|
static Note[] |
getNotesWithContent(Note[] notes_)
Deprecated.
use ProcessExecution.getNotesWithContent(Note[], ServiceContext)
|
Identity |
getOwner()
Gets the id and name of the owner of this node.
|
java.lang.Long |
getOwnerId()
Gets the id of the user that owns this node.
|
java.lang.String |
getOwnerName()
Gets the name of the user that owns this node.
|
java.lang.Long |
getPaletteIcon()
Gets the icon of the palette item from which this node was added to the
process model.
|
EventTrigger[] |
getPostTriggers()
Gets the post-triggers.
|
EventTrigger[] |
getPreTriggers()
Gets pre-triggers.
|
java.lang.Long |
getPreviousId()
Gets the primary key that this node had in a previous version of this
model.
|
Priority |
getPriority()
Gets the priority for this node.
|
boolean |
getRefreshDefaultValues()
Determines whether to refresh the default values each time a task
form is viewed.
|
protected abstract AbstractSchedule |
getScheduleAbstraction() |
java.lang.Float |
getTargetCompletion()
Gets the target duration in which the task should complete
|
java.lang.Float |
getTargetLag()
Gets the target duration in which the task should be accepted
|
java.lang.String |
getUuid() |
java.lang.Long |
getX()
Gets the horizontal coordinate of this node, which tells graphical
designers where to render the icon.
|
java.lang.Long |
getY()
Gets the vertical coordinate of this node, which tells graphical
designers where to render the icon.
|
boolean |
isAllowsBack()
Determines if a user is allowed to step back to this node in
an activity chain.
|
boolean |
isLingering()
a node is lingering if its existance is known to execution server only.
|
boolean |
isNotify()
Determines whether this node has a notification associated with it.
|
boolean |
isOnCompleteDeletePreviousCompleted() |
boolean |
isOnCompleteKeepFormData() |
boolean |
isOnCreateDeletePreviousActive() |
boolean |
isOnCreateIgnoreIfActive() |
boolean |
isOverrideLaneAssignment()
Gets whether the node overrides the assignment of the lane in which it is
contained.
|
boolean |
isSkipNotification() |
boolean |
isStartNode()
Used by tracking logic, this property is not always available.
|
static void |
mergeNodes(AbstractProcessNode[] dbNodes_,
AbstractProcessNode[] fsNodes_) |
void |
setActivityClass(ActivityClass activityClass_)
Gets the primary activity class associated with this node.
|
void |
setAllowsBack(boolean allowsBack_)
Set whether a user is allowed to step back to this node in an
activity chain.
|
void |
setAssign(Assignment assign_)
If this node has an attended primary activity, this method sets the
people, groups, etc.
|
void |
setAssociations(Connection[] associations_) |
void |
setAttachments(Attachment[] attachments_)
Gets the attachments that have been attached to this node.
|
void |
setConfirmationUrl(java.lang.String confirmationUrl_)
Sets the URL to which the runtime user should be forwarded after
successfully completing the activity associated with this node.
|
void |
setConnections(Connection[] connections_)
Sets the collection of flows representing connections to other nodes.
|
void |
setDeadline(Deadline deadline_) |
void |
setDefaultNodeInstanceSecurity(Security defaultNodeInstanceSecurity_)
Sets the default security mapping for instances of this node.
|
void |
setDescription(LocaleString description_)
Sets the localized description mappings for this node.
|
void |
setDisplay(LocaleString display_)
See
getDisplay() . |
void |
setEventProducers(EventProducer[] eventProducers_)
Sets the event producers for this node
|
void |
setExceptionFlow(Connection exceptionFlow_) |
void |
setExceptionFlowTriggers(EventTrigger[] exceptionFlowTriggers_)
Sets the triggers that can trigger an exception flow
|
void |
setFriendlyName(LocaleString friendlyName_)
See
getFriendlyName() . |
void |
setGroupOwner(Identity groupOwner_)
Sets the group that owns this process node.
|
void |
setGroupOwnerId(java.lang.Long groupOwnerId_)
Sets the group owner id of this node.
|
void |
setGroupOwnerName(java.lang.String groupOwnerName_)
Sets the name of the group that owns this node.
|
void |
setGuiId(java.lang.Long guiId_)
Sets the
guiId of this node. |
void |
setIcon(java.lang.Long icon_)
Sets the id of the icon of the process node.
|
void |
setId(java.lang.Long id_)
Sets the primary key of this node.
|
void |
setLabelStyle(Label labelStyle_)
Sets the styling bean for this node's label.
|
void |
setLane(java.lang.Long lane_)
Sets the index of the
Lane in which this node is contained. |
void |
setLingering(boolean lingering_) |
void |
setMultipleInstance(MultipleInstance multipleInstance_)
Sets the multiple instance configuration of the node.
|
void |
setNotes(Note[] notes_)
Sets the notes that have been attached to this node.
|
void |
setNotify(boolean notify_)
Sets whether there is notification associated with this node.
|
void |
setOnCompleteDeletePreviousCompleted(boolean onCompleteDeletePreviousCompleted_) |
void |
setOnCompleteKeepFormData(boolean onCompleteKeepFormData_) |
void |
setOnCreateDeletePreviousActive(boolean onCreateDeletePreviousActive_) |
void |
setOnCreateIgnoreIfActive(boolean onCreateIgnoreIfActive_) |
void |
setOverrideLaneAssignment(boolean overrideLaneAssignment_)
Sets whether the node overrides the assignment of the lane in which it is
contained.
|
void |
setOwner(Identity owner_)
Sets the identity of the owner of the process node
|
void |
setOwnerId(java.lang.Long ownerId_)
Sets the user that owns this node.
|
void |
setOwnerName(java.lang.String ownerName_)
Sets the user that owns this node.
|
void |
setPaletteIcon(java.lang.Long paletteIcon_)
Sets the icon of the palette item from which this node was added to the
process model.
|
void |
setPostTriggers(EventTrigger[] postTriggers_)
Sets the post-triggers
|
void |
setPreTriggers(EventTrigger[] preTriggers_)
Sets the pre-triggers
|
void |
setPreviousId(java.lang.Long previousId_)
Sets the primary key that this node had in a previous version of this
model.
|
void |
setPriority(Priority priority_)
Sets the priority for this node.
|
void |
setRefreshDefaultValues(boolean refreshDefaultValues_)
Sets whether to refresh the default values each time a task form
is viewed.
|
void |
setSkipNotification(boolean skipNotification_) |
void |
setStartNode(boolean startNode)
Used by tracking logic, this property is not always available.
|
void |
setTargetCompletion(java.lang.Float targetCompletion_)
Sets the target duration in which the process should complete
|
void |
setTargetLag(java.lang.Float targetLag_)
Sets the target duration in which the task should be accepted
|
void |
setUuid(java.lang.String uuid_) |
void |
setX(java.lang.Long x_)
Sets the horizontal coordinate of this node, which tells graphical
designers where to render the icon.
|
void |
setY(java.lang.Long y_)
Gets the vertical coordinate of this node, which tells graphical
designers where to render the icon.
|
java.lang.String |
toString()
Converts the process node to a string, which can be used in debugging.
|
public static final java.lang.Float DEFAULT_COMPLETION
public static final java.lang.Float DEFAULT_LAG
public java.util.HashSet getHiddenAttributes()
JSONable
getHiddenAttributes
in interface JSONable
public Priority getPriority()
public void setPriority(Priority priority_)
priority_
- the priority for this node.public ActivityClass getActivityClass()
public void setActivityClass(ActivityClass activityClass_)
activityClass_
- the activity class that runs when this node is
traversed in a process at runtime.public Connection[] getConnections()
public void setConnections(Connection[] connections_)
connections_
- the flows that leave this node and connect to other
nodes.public Connection[] getAssociations()
public void setAssociations(Connection[] associations_)
public LocaleString getFriendlyName()
getDisplay()
public void setFriendlyName(LocaleString friendlyName_)
getFriendlyName()
.public Identity getGroupOwner()
public void setGroupOwner(Identity groupOwner_)
groupOwner_
- the group owner of the process node.public java.lang.Long getIcon()
public void setIcon(java.lang.Long icon_)
public Identity getOwner()
public void setOwner(Identity owner_)
owner_
- the id and name of the owner of this node.public java.lang.Long getX()
public void setX(java.lang.Long x_)
x_
- the horizontal coordinate of this node.public java.lang.Long getY()
public void setY(java.lang.Long y_)
y_
- the vertical coordinate of this node.protected abstract AbstractEscalation[] getEscalationAbstraction()
protected abstract AbstractSchedule getScheduleAbstraction()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Long getGuiId()
guiId
of this node. The guiId
is an
internal identifier, used by graphcial tools. Think of it as the id of
this node within the context of a model, in contrast to the "id"
property, which is the primary key in the database. Generally, the
first node added to the model is 0, the second node is 1, and so on.
This id is used by connections.guiId
of this node.public void setGuiId(java.lang.Long guiId_)
guiId
of this node. The guiId
is an
internal identifier, used by graphcial tools. Think of it as the id of
this node within the context of a model, in contrast to the "id"
property, which is the primary key in the database. Generally, the
first node added to the model is 0, the second node is 1, and so on.
This id is used by connections.guiId_
- the guiId
of this node.public java.lang.Long getId()
public void setId(java.lang.Long id_)
id_
- the primary key of this node.public java.lang.Long getGroupOwnerId()
public void setGroupOwnerId(java.lang.Long groupOwnerId_)
groupOwnerId_
- the id of the group that owns this node.public java.lang.String getGroupOwnerName()
public void setGroupOwnerName(java.lang.String groupOwnerName_)
groupOwnerName_
- the name of the group that owns this node.public java.lang.Long getOwnerId()
public void setOwnerId(java.lang.Long ownerId_)
ownerId_
- the id of the user that owns this node.public java.lang.String getOwnerName()
public void setOwnerName(java.lang.String ownerName_)
ownerName_
- the username of the user that owns this node.public java.lang.Long getPreviousId()
public void setPreviousId(java.lang.Long previousId_)
public Assignment getAssign()
public void setAssign(Assignment assign_)
assign_
- the entities to whom this node is assigned.public LocaleString getDescription()
public void setDescription(LocaleString description_)
description_
- the description of this node.public LocaleString getDisplay()
getFriendlyName()
public void setDisplay(LocaleString display_)
getDisplay()
.public boolean isNotify()
true
if this node has an associated notification,
false
otherwise.public void setNotify(boolean notify_)
notify_
- true
if this node has an associated
notification, false
otherwise.public java.lang.String getConfirmationUrl()
public void setConfirmationUrl(java.lang.String confirmationUrl_)
confirmationUrl_
- the url to whcih the user is forwarded
after succesful completion of this node.public java.lang.Long getPaletteIcon()
public void setPaletteIcon(java.lang.Long paletteIcon_)
paletteIcon_
- the id of a document which is stored in content
management.public void fillInAppianTypes(AppianTypeCache cache_)
fillInAppianTypes
in interface AppianTypeHolder
cache_
- cache of Appian-typed objects.public Security getDefaultNodeInstanceSecurity()
public void setDefaultNodeInstanceSecurity(Security defaultNodeInstanceSecurity_)
defaultNodeInstanceSecurity_
- the default security
mapping for instances of this node.public MultipleInstance getMultipleInstance()
public void setMultipleInstance(MultipleInstance multipleInstance_)
multipleInstance_
- configurationpublic java.lang.Float getTargetCompletion()
public void setTargetCompletion(java.lang.Float targetCompletion_)
targetCompletion_
- the target duration in days in which the task
should completepublic java.lang.Float getTargetLag()
public void setTargetLag(java.lang.Float targetLag_)
targetLag_
- the target duration in days in which the task
should be acceptedpublic Note[] getNotes()
public void setNotes(Note[] notes_)
notes_
- the notes that have been attached to this node.@Deprecated public static Note[] getNotesWithContent(Note[] notes_)
notes_
- array of Notes to populatepublic Attachment[] getAttachments()
public void setAttachments(Attachment[] attachments_)
attachments_
- the attachments that have been attached to this node.public boolean isLingering()
public void setLingering(boolean lingering_)
public EventTrigger[] getExceptionFlowTriggers()
public void setExceptionFlowTriggers(EventTrigger[] exceptionFlowTriggers_)
exceptionFlowTriggers_
- the exception flow triggerspublic EventTrigger[] getPreTriggers()
public void setPreTriggers(EventTrigger[] preTriggers_)
preTriggers_
- the pre-triggersgetPreTriggers()
public EventTrigger[] getPostTriggers()
public EventProducer[] getEventProducers()
public void setEventProducers(EventProducer[] eventProducers_)
eventProducers_
- the event producerspublic void setPostTriggers(EventTrigger[] postTriggers_)
postTriggers_
- getPostTriggers()
public java.lang.Long getLane()
Lane
in which this node
is contained. This number indexes into the Lanes
field in
AbstractProcessModel
. If this node is not contained within a
Lane
then this value will be -1.Lane
in which this node is containedpublic void setLane(java.lang.Long lane_)
Lane
in which this node is contained.lane_
- The index of the Lane
in which this node is
containedgetLane()
public boolean isOverrideLaneAssignment()
public void setOverrideLaneAssignment(boolean overrideLaneAssignment_)
overrideLaneAssignment_
- Whether the node overrides the assignment
of the lane in which it is contained.isOverrideLaneAssignment()
public Label getLabelStyle()
Label
bean for this node.public void setLabelStyle(Label labelStyle_)
labelStyle_
- Sets the Label
bean for this node.getLabelStyle()
public static void mergeNodes(AbstractProcessNode[] dbNodes_, AbstractProcessNode[] fsNodes_)
public Deadline getDeadline()
public void setDeadline(Deadline deadline_)
public Connection getExceptionFlow()
public void setExceptionFlow(Connection exceptionFlow_)
public boolean isOnCompleteDeletePreviousCompleted()
public void setOnCompleteDeletePreviousCompleted(boolean onCompleteDeletePreviousCompleted_)
onCompleteDeletePreviousCompleted_
- The onCompleteDeletePreviousCompleted to set.public boolean isOnCompleteKeepFormData()
public void setOnCompleteKeepFormData(boolean onCompleteKeepFormData_)
public boolean isOnCreateDeletePreviousActive()
public void setOnCreateDeletePreviousActive(boolean onCreateDeletePreviousActive_)
onCreateDeletePreviousActive_
- The onCreateDeletePreviousActive to set.public boolean isOnCreateIgnoreIfActive()
public void setOnCreateIgnoreIfActive(boolean onCreateIgnoreIfActive_)
onCreateIgnoreIfActive_
- The onCreateIgnoreIfActive to set.public boolean isAllowsBack()
setAllowsBack(boolean)
public void setAllowsBack(boolean allowsBack_)
allowsBack_
- true to allow users to step back to this nodeisAllowsBack()
public boolean getRefreshDefaultValues()
setRefreshDefaultValues(boolean)
public void setRefreshDefaultValues(boolean refreshDefaultValues_)
refreshDefaultValues_
- true to refresh the default valuesgetRefreshDefaultValues()
@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public java.lang.String getUuid()
public void setUuid(java.lang.String uuid_)
uuid
- The uuid to set.public boolean isSkipNotification()
true
if we are skipping notification emails
for this node, false
otherwisepublic void setSkipNotification(boolean skipNotification_)
skipNotification_
- true
to skip notification
emails for this node, false
otherwisepublic boolean isStartNode()
public void setStartNode(boolean startNode)
startNode
- set this as a start node, either implicit or explicit.Copyright © 2003-2024 Appian Corporation. All Rights Reserved.