Package com.appiancorp.suiteapi.process
Class RuntimeProcessNode
java.lang.Object
com.appiancorp.suiteapi.process.AbstractProcessNode
com.appiancorp.suiteapi.process.RuntimeProcessNode
- All Implemented Interfaces:
JSONable
,JSONCacheable
,AppianTypeHolder
,Serializable
Information about a node in an executed process. For nodes with multiple
instances, only one
ProcessNode
instance exists for the node.- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.suiteapi.process.AbstractProcessNode
DEFAULT_COMPLETION, DEFAULT_LAG
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected AbstractEscalation[]
Returns the escalation properties of all node instancesLong[]
Returns the instance ids for each instance of the node (currently the same as the activity ids)Returns schedule information if a schedule was set up for this nodeprotected AbstractSchedule
Returns the number of instances that have been spawned.Returns the status of the process node.void
setEscalationInstances
(EscalationInstance[] escalations_) void
setEscalations
(EscalationInstance[] escalations_) Sets the escalation properties of all node instancesvoid
setInstanceIds
(Long[] ids_) Sets the instance ids for each instance of the nodevoid
setSchedule
(ScheduleInstance instance_) Sets schedule information for this nodevoid
setScheduleInstances
(ScheduleInstance instance_) void
setSpawnedInstances
(Long spawnedInstances_) Sets the number of instances that have spawnedvoid
Sets the status of the process nodeMethods inherited from class com.appiancorp.suiteapi.process.AbstractProcessNode
fillInAppianTypes, getActivityClass, getAssign, getAssociations, getAttachments, getConfirmationUrl, getConnections, getDeadline, getDefaultNodeInstanceSecurity, getDescription, getDisplay, getEventProducers, getExceptionFlow, getExceptionFlowTriggers, getFriendlyName, getGroupOwner, getGroupOwnerId, getGroupOwnerName, getGuiId, getHiddenAttributes, getIcon, getId, getLabelStyle, getLane, getMultipleInstance, getNotes, getNotesWithContent, getOwner, getOwnerId, getOwnerName, getPaletteIcon, getPostTriggers, getPreTriggers, getPreviousId, getPriority, getRefreshDefaultValues, getTargetCompletion, getTargetLag, getUuid, getX, getY, isAllowsBack, isLingering, isNotify, isOnCompleteDeletePreviousCompleted, isOnCompleteKeepFormData, isOnCreateDeletePreviousActive, isOnCreateIgnoreIfActive, isOverrideLaneAssignment, isSkipNotification, isStartNode, mergeNodes, setActivityClass, setAllowsBack, setAssign, setAssociations, setAttachments, setConfirmationUrl, setConnections, setDeadline, setDefaultNodeInstanceSecurity, setDescription, setDisplay, setEventProducers, setExceptionFlow, setExceptionFlowTriggers, setFriendlyName, setGroupOwner, setGroupOwnerId, setGroupOwnerName, setGuiId, setIcon, setId, setLabelStyle, setLane, setLingering, setMultipleInstance, setNotes, setNotify, setOnCompleteDeletePreviousCompleted, setOnCompleteKeepFormData, setOnCreateDeletePreviousActive, setOnCreateIgnoreIfActive, setOverrideLaneAssignment, setOwner, setOwnerId, setOwnerName, setPaletteIcon, setPostTriggers, setPreTriggers, setPreviousId, setPriority, setRefreshDefaultValues, setSkipNotification, setStartNode, setTargetCompletion, setTargetLag, setUuid, setX, setY, toString
-
Constructor Details
-
RuntimeProcessNode
public RuntimeProcessNode()
-
-
Method Details
-
getEscalations
Returns the escalation properties of all node instances- Returns:
- an
Array
ofEscalationInstance
objects which contain the escalation properties
-
getEscalationAbstraction
- Specified by:
getEscalationAbstraction
in classAbstractProcessNode
-
setEscalations
Sets the escalation properties of all node instances- Parameters:
escalations_
- anArray
ofEscalationInstance
objects which contain the escalation properties
-
setEscalationInstances
-
getSpawnedInstances
Returns the number of instances that have been spawned. If the node has not yet been reached, this number will be 0. If the node has been set to spawn, and the node has been activated (ie is currently active, has been completed, or was cancelled or paused after being activated), this will be the number of instances which have been spawned, inclusive of spawned instances as a result of a recurrence.- Returns:
- the number of instances that have been spawned
-
setSpawnedInstances
Sets the number of instances that have spawned- Parameters:
spawnedInstances_
- the number of instances that have been spawned- See Also:
-
getStatus
Returns the status of the process node. The value will be one of the STATUS fields ofTaskSummary
if the node has several spawned instances. For nodes with multiple instances, the status will be incomplete until all instances are complete- Returns:
- the status of the process node
-
setStatus
Sets the status of the process node- Parameters:
status_
- the status of the process node- See Also:
-
getInstanceIds
Returns the instance ids for each instance of the node (currently the same as the activity ids)- Returns:
- the instance ids
-
setInstanceIds
Sets the instance ids for each instance of the node- Parameters:
ids_
- the instance ids
-
getSchedule
Returns schedule information if a schedule was set up for this node- Returns:
- a
ScheduleInstance
object for the node, ornull
if the node was not set up on a schedule
-
setSchedule
Sets schedule information for this node- Parameters:
instance_
- the schedule information
-
setScheduleInstances
-
getScheduleAbstraction
- Specified by:
getScheduleAbstraction
in classAbstractProcessNode
-