Package com.appiancorp.suiteapi.process
Class AbstractProcessNode
java.lang.Object
com.appiancorp.suiteapi.process.AbstractProcessNode
- All Implemented Interfaces:
JSONable
,JSONCacheable
,AppianTypeHolder
,Serializable
- Direct Known Subclasses:
ProcessNode
,RuntimeProcessNode
A node in a process model. A node is a conceptual representation of an
activity used in a
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.- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Float
The default time, in days, in which each node should complete.static final Float
The default log, in days, in which ecah node should complete.Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Gets the primary activity class associated with this node.If this node has an attended primary activity, this method gets the people, groups, etc. to whom the activity is assigned.Gets the attachments that have been attached to this node.Gets the URL to which the runtime user should be forwarded after successfully completing the activity associated with this node.Gets the collection of flows representing connections to other nodes.Gets the default security mapping for instances of this node.Gets the localized description mappings of this node.Returns the task display name for this node.protected abstract AbstractEscalation[]
Gets the event producers for this nodeGets the triggers that can trigger an exception flowReturns the name of this node.Gets the group that owns this process node.Gets the group that owns this node.Gets the name of the group that owns this node.getGuiId()
Gets theguiId
of this node.Returns the set of attributes (properties) that should not be included in the JSON representation of the object.getIcon()
Gets the id of the icon of the process node.getId()
Gets the primary key of this node.Gets the styling bean for this node's label.getLane()
Gets the index of theLane
in which this node is contained.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)getOwner()
Gets the id and name of the owner of this node.Gets the id of the user that owns this node.Gets the name of the user that owns this node.Gets the icon of the palette item from which this node was added to the process model.Gets the post-triggers.Gets pre-triggers.Gets the primary key that this node had in a previous version of this model.Gets the priority for this node.boolean
Determines whether to refresh the default values each time a task form is viewed.protected abstract AbstractSchedule
Gets the target duration in which the task should completeGets the target duration in which the task should be acceptedgetUuid()
getX()
Gets the horizontal coordinate of this node, which tells graphical designers where to render the icon.getY()
Gets the vertical coordinate of this node, which tells graphical designers where to render the icon.boolean
Determines if a user is allowed to step back to this node in an activity chain.boolean
a node is lingering if its existence is known to execution server only.boolean
isNotify()
Determines whether this node has a notification associated with it.boolean
boolean
boolean
boolean
boolean
Gets whether the node overrides the assignment of the lane in which it is contained.boolean
boolean
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. to whom the activity is assigned.void
setAssociations
(Connection[] associations_) void
setAttachments
(Attachment[] attachments_) Gets the attachments that have been attached to this node.void
setConfirmationUrl
(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_) SeegetDisplay()
.void
setEventProducers
(EventProducer[] eventProducers_) Sets the event producers for this nodevoid
setExceptionFlow
(Connection exceptionFlow_) void
setExceptionFlowTriggers
(EventTrigger[] exceptionFlowTriggers_) Sets the triggers that can trigger an exception flowvoid
setFriendlyName
(LocaleString friendlyName_) SeegetFriendlyName()
.void
setGroupOwner
(Identity groupOwner_) Sets the group that owns this process node.void
setGroupOwnerId
(Long groupOwnerId_) Sets the group owner id of this node.void
setGroupOwnerName
(String groupOwnerName_) Sets the name of the group that owns this node.void
Sets theguiId
of this node.void
Sets the id of the icon of the process node.void
Sets the primary key of this node.void
setLabelStyle
(Label labelStyle_) Sets the styling bean for this node's label.void
Sets the index of theLane
in which this node is contained.void
setLingering
(boolean lingering_) void
setMultipleInstance
(MultipleInstance multipleInstance_) Sets the multiple instance configuration of the node.void
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
Sets the identity of the owner of the process nodevoid
setOwnerId
(Long ownerId_) Sets the user that owns this node.void
setOwnerName
(String ownerName_) Sets the user that owns this node.void
setPaletteIcon
(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-triggersvoid
setPreTriggers
(EventTrigger[] preTriggers_) Sets the pre-triggersvoid
setPreviousId
(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
(Float targetCompletion_) Sets the target duration in which the process should completevoid
setTargetLag
(Float targetLag_) Sets the target duration in which the task should be acceptedvoid
void
Sets the horizontal coordinate of this node, which tells graphical designers where to render the icon.void
Gets the vertical coordinate of this node, which tells graphical designers where to render the icon.toString()
Converts the process node to a string, which can be used in debugging.
-
Field Details
-
DEFAULT_COMPLETION
The default time, in days, in which each node should complete. -
DEFAULT_LAG
The default log, in days, in which ecah node should complete.
-
-
Constructor Details
-
AbstractProcessNode
public AbstractProcessNode()
-
-
Method Details
-
getHiddenAttributes
Description copied from interface:JSONable
Returns the set of attributes (properties) that should not be included in the JSON representation of the object.- Specified by:
getHiddenAttributes
in interfaceJSONable
- Returns:
- the set of hidden attributes
-
getPriority
Gets the priority for this node.- Returns:
- the priority for this node.
-
setPriority
Sets the priority for this node.- Parameters:
priority_
- the priority for this node.
-
getActivityClass
Gets the primary activity class associated with this node.- Returns:
- the activity class that runs when this node is traversed in a process at runtime.
-
setActivityClass
Gets the primary activity class associated with this node.- Parameters:
activityClass_
- the activity class that runs when this node is traversed in a process at runtime.
-
getConnections
Gets the collection of flows representing connections to other nodes.- Returns:
- the flows that leave this node and connect to other nodes.
-
setConnections
Sets the collection of flows representing connections to other nodes.- Parameters:
connections_
- the flows that leave this node and connect to other nodes.
-
getAssociations
-
setAssociations
-
getFriendlyName
Returns the name of this node.- See Also:
-
setFriendlyName
SeegetFriendlyName()
. -
getGroupOwner
Gets the group that owns this process node.- Returns:
- the group owner of the process node.
-
setGroupOwner
Sets the group that owns this process node.- Parameters:
groupOwner_
- the group owner of the process node.
-
getIcon
Gets the id of the icon of the process node. Icons are documents stored in content management. -
setIcon
Sets the id of the icon of the process node. Icons are documents stored in content management. -
getOwner
Gets the id and name of the owner of this node.- Returns:
- the identity of the owner of the process node
-
setOwner
Sets the identity of the owner of the process node- Parameters:
owner_
- the id and name of the owner of this node.
-
getX
Gets the horizontal coordinate of this node, which tells graphical designers where to render the icon.- Returns:
- the horizontal coordinate of this node.
-
setX
Sets the horizontal coordinate of this node, which tells graphical designers where to render the icon.- Parameters:
x_
- the horizontal coordinate of this node.
-
getY
Gets the vertical coordinate of this node, which tells graphical designers where to render the icon.- Returns:
- the vertical coordinate of this node.
-
setY
Gets the vertical coordinate of this node, which tells graphical designers where to render the icon.- Parameters:
y_
- the vertical coordinate of this node.
-
getEscalationAbstraction
-
getScheduleAbstraction
-
toString
Converts the process node to a string, which can be used in debugging. -
getGuiId
Gets theguiId
of this node. TheguiId
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.- Returns:
- the
guiId
of this node.
-
setGuiId
Sets theguiId
of this node. TheguiId
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.- Parameters:
guiId_
- theguiId
of this node.
-
getId
Gets the primary key of this node.- Returns:
- the primary key of this node.
-
setId
Sets the primary key of this node.- Parameters:
id_
- the primary key of this node.
-
getGroupOwnerId
Gets the group that owns this node.- Returns:
- the id of the group that owns this node.
-
setGroupOwnerId
Sets the group owner id of this node.- Parameters:
groupOwnerId_
- the id of the group that owns this node.
-
getGroupOwnerName
Gets the name of the group that owns this node.- Returns:
- the name of the group that owns this node.
-
setGroupOwnerName
Sets the name of the group that owns this node.- Parameters:
groupOwnerName_
- the name of the group that owns this node.
-
getOwnerId
Gets the id of the user that owns this node.- Returns:
- the owner id of this node
-
setOwnerId
Sets the user that owns this node.- Parameters:
ownerId_
- the id of the user that owns this node.
-
getOwnerName
Gets the name of the user that owns this node.- Returns:
- the owner name of the process node
-
setOwnerName
Sets the user that owns this node.- Parameters:
ownerName_
- the username of the user that owns this node.
-
getPreviousId
Gets the primary key that this node had in a previous version of this model. This is probably not useful, but some tools may take advantage of it later. -
setPreviousId
Sets the primary key that this node had in a previous version of this model. This is probably not useful, but some tools may take advantage of it later. -
getAssign
If this node has an attended primary activity, this method gets the people, groups, etc. to whom the activity is assigned.- Returns:
- the entities to whom this node is assigned.
-
setAssign
If this node has an attended primary activity, this method sets the people, groups, etc. to whom the activity is assigned.- Parameters:
assign_
- the entities to whom this node is assigned.
-
getDescription
Gets the localized description mappings of this node.- Returns:
- the description for this node.
-
setDescription
Sets the localized description mappings for this node.- Parameters:
description_
- the description of this node.
-
getDisplay
Returns the task display name for this node.- See Also:
-
setDisplay
SeegetDisplay()
. -
isNotify
public boolean isNotify()Determines whether this node has a notification associated with it.- Returns:
true
if this node has an associated notification,false
otherwise.
-
setNotify
public void setNotify(boolean notify_) Sets whether there is notification associated with this node.- Parameters:
notify_
-true
if this node has an associated notification,false
otherwise.
-
getConfirmationUrl
Gets the URL to which the runtime user should be forwarded after successfully completing the activity associated with this node. This data is only useful for nodes with attended primary activities.- Returns:
- the url to which the user is forwarded after successful completion of this node.
-
setConfirmationUrl
Sets the URL to which the runtime user should be forwarded after successfully completing the activity associated with this node. This data is only useful for nodes with attended primary activities.- Parameters:
confirmationUrl_
- the url to whcih the user is forwarded after succesful completion of this node.
-
getPaletteIcon
Gets the icon of the palette item from which this node was added to the process model.- Returns:
- the id of a document which is stored in content management.
-
setPaletteIcon
Sets the icon of the palette item from which this node was added to the process model.- Parameters:
paletteIcon_
- the id of a document which is stored in content management.
-
fillInAppianTypes
Adds the primary keys of any Appian-typed objects that are used by the activites or escalations of this node to the given cache.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Parameters:
cache_
- cache of Appian-typed objects.
-
getDefaultNodeInstanceSecurity
Gets the default security mapping for instances of this node.- Returns:
- the default security mapping for instances of this node.
-
setDefaultNodeInstanceSecurity
Sets the default security mapping for instances of this node.- Parameters:
defaultNodeInstanceSecurity_
- the default security mapping for instances of this node.
-
getMultipleInstance
Returns the multiple instance configuration of the node. This may include Spawning and Recurrence configurations.- Returns:
- Multiple instance configuration of the node.
-
setMultipleInstance
Sets the multiple instance configuration of the node. The may include Spawning and Recurrence configurations.- Parameters:
multipleInstance_
- configuration
-
getTargetCompletion
Gets the target duration in which the task should complete- Returns:
- a value representing the number of days
-
setTargetCompletion
Sets the target duration in which the process should complete- Parameters:
targetCompletion_
- the target duration in days in which the task should complete
-
getTargetLag
Gets the target duration in which the task should be accepted- Returns:
- a value representing the number of days
-
setTargetLag
Sets the target duration in which the task should be accepted- Parameters:
targetLag_
- the target duration in days in which the task should be accepted
-
getNotes
Gets the notes that have been attached to this node.- Returns:
- the notes that have been attached to this node.
-
setNotes
Sets the notes that have been attached to this node.- Parameters:
notes_
- the notes that have been attached to this node.
-
getNotesWithContent
Deprecated.use ProcessExecution.getNotesWithContent(Note[], ServiceContext)Returns the notes with content populated from fileSystem.- Parameters:
notes_
- array of Notes to populate- Returns:
- content populates notes array.
-
getAttachments
Gets the attachments that have been attached to this node.- Returns:
- the attachments that have been attached to this node.
-
setAttachments
Gets the attachments that have been attached to this node.- Parameters:
attachments_
- the attachments that have been attached to this node.
-
isLingering
public boolean isLingering()a node is lingering if its existence is known to execution server only. i.e. when the task is instantiated, analytics and notifications servers are not notified of it. this property is currently only used to implement "quicktasks" -
setLingering
public void setLingering(boolean lingering_) -
getExceptionFlowTriggers
Gets the triggers that can trigger an exception flow- Returns:
- the exception flow triggers
-
setExceptionFlowTriggers
Sets the triggers that can trigger an exception flow- Parameters:
exceptionFlowTriggers_
- the exception flow triggers
-
getPreTriggers
Gets pre-triggers. These triggers are activated once the node is reached in flow. If the node is not reached in flow, these triggers are activated when the process is started)- Returns:
- the pre-triggers
-
setPreTriggers
Sets the pre-triggers- Parameters:
preTriggers_
- the pre-triggers- See Also:
-
getPostTriggers
Gets the post-triggers. These triggers are activated after the node has otherwise completed. The triggers must fire before flow can move on.- Returns:
- the post-triggers
-
getEventProducers
Gets the event producers for this node- Returns:
- the event producers
-
setEventProducers
Sets the event producers for this node- Parameters:
eventProducers_
- the event producers
-
setPostTriggers
Sets the post-triggers- Parameters:
postTriggers_
-- See Also:
-
getLane
Gets the index of theLane
in which this node is contained. This number indexes into theLanes
field inAbstractProcessModel
. If this node is not contained within aLane
then this value will be -1.- Returns:
- The index of the
Lane
in which this node is contained
-
setLane
Sets the index of theLane
in which this node is contained.- Parameters:
lane_
- The index of theLane
in which this node is contained- See Also:
-
isOverrideLaneAssignment
public boolean isOverrideLaneAssignment()Gets whether the node overrides the assignment of the lane in which it is contained. This field is ignored if- The node is not contained within a lane
- The node's lane does not have lane assignment set
- The node cannot run as the lane assignment specifies. EG. A node that must be attended within a lane that has unattended lane assignment. In this case the lane assignment will always be overriden, regardless of the value returned by this function
- Returns:
- Whether the node overrids the assignment of the line in which it is contained.
-
setOverrideLaneAssignment
public void setOverrideLaneAssignment(boolean overrideLaneAssignment_) Sets whether the node overrides the assignment of the lane in which it is contained.- Parameters:
overrideLaneAssignment_
- Whether the node overrides the assignment of the lane in which it is contained.- See Also:
-
getLabelStyle
Gets the styling bean for this node's label. The bean contains information on how to style the label such as font color, size, and decoration.- Returns:
- The
Label
bean for this node.
-
setLabelStyle
Sets the styling bean for this node's label.- Parameters:
labelStyle_
- Sets theLabel
bean for this node.- See Also:
-
mergeNodes
-
getDeadline
-
setDeadline
-
getExceptionFlow
-
setExceptionFlow
-
isOnCompleteDeletePreviousCompleted
public boolean isOnCompleteDeletePreviousCompleted()- Returns:
- Returns the onCompleteDeletePreviousCompleted.
-
setOnCompleteDeletePreviousCompleted
public void setOnCompleteDeletePreviousCompleted(boolean onCompleteDeletePreviousCompleted_) - Parameters:
onCompleteDeletePreviousCompleted_
- The onCompleteDeletePreviousCompleted to set.
-
isOnCompleteKeepFormData
public boolean isOnCompleteKeepFormData() -
setOnCompleteKeepFormData
public void setOnCompleteKeepFormData(boolean onCompleteKeepFormData_) -
isOnCreateDeletePreviousActive
public boolean isOnCreateDeletePreviousActive()- Returns:
- Returns the onCreateDeletePreviousActive.
-
setOnCreateDeletePreviousActive
public void setOnCreateDeletePreviousActive(boolean onCreateDeletePreviousActive_) - Parameters:
onCreateDeletePreviousActive_
- The onCreateDeletePreviousActive to set.
-
isOnCreateIgnoreIfActive
public boolean isOnCreateIgnoreIfActive()- Returns:
- Returns the onCreateIgnoreIfActive.
-
setOnCreateIgnoreIfActive
public void setOnCreateIgnoreIfActive(boolean onCreateIgnoreIfActive_) - Parameters:
onCreateIgnoreIfActive_
- The onCreateIgnoreIfActive to set.
-
isAllowsBack
public boolean isAllowsBack()Determines if a user is allowed to step back to this node in an activity chain.- Returns:
- true if the user is allowed to step back to this node
- See Also:
-
setAllowsBack
public void setAllowsBack(boolean allowsBack_) Set whether a user is allowed to step back to this node in an activity chain.- Parameters:
allowsBack_
- true to allow users to step back to this node- See Also:
-
getRefreshDefaultValues
public boolean getRefreshDefaultValues()Determines whether to refresh the default values each time a task form is viewed.- Returns:
- true if the default values should be refreshed
- See Also:
-
setRefreshDefaultValues
public void setRefreshDefaultValues(boolean refreshDefaultValues_) Sets whether to refresh the default values each time a task form is viewed.- Parameters:
refreshDefaultValues_
- true to refresh the default values- See Also:
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()- Returns:
- Returns the uuid.
-
setUuid
- Parameters:
uuid
- The uuid to set.
-
isSkipNotification
public boolean isSkipNotification()- Returns:
true
if we are skipping notification emails for this node,false
otherwise
-
setSkipNotification
public void setSkipNotification(boolean skipNotification_) - Parameters:
skipNotification_
-true
to skip notification emails for this node,false
otherwise
-
isStartNode
public boolean isStartNode()Used by tracking logic, this property is not always available.- Returns:
- is this marked as a start node, either implicit or explicit?
-
setStartNode
public void setStartNode(boolean startNode) Used by tracking logic, this property is not always available.- Parameters:
startNode
- set this as a start node, either implicit or explicit.
-