Package com.appiancorp.suiteapi.process
Class ProcessDiagram
java.lang.Object
com.appiancorp.suiteapi.common.LocalizedIdentity
com.appiancorp.suiteapi.process.AbstractProcessModel
com.appiancorp.suiteapi.process.ProcessDiagram
- All Implemented Interfaces:
JSONable
,JSONCacheable
,AppianTypeHolder
,Serializable
A runtime representation of a
ProcessModel
. The nodes in
the diagram represent the tasks in the process. The diagram can be
used to make in-flight modifications.- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.suiteapi.process.AbstractProcessModel
AUTO_ARCHIVE, AUTO_DELETE, DEFAULT_COMPLETION, EPEX_EXEC_ENVIRONMENT, K_EXEC_ENVIRONMENT, LATEST_PUBLISHED_VERSION, NO_CLEANUP, RESULT_CODE_INVALID, RESULT_CODE_NO_PERM_PUBLISH, RESULT_CODE_SUCCESS, STATUS_DRAFT, STATUS_PUBLISHED, STATUS_VERSION, SYS_AUTOARCHIVE, SYS_AUTOARCHIVE_DELAY, SYSTEM_DEFAULT
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
fillInAppianTypes
(AppianTypeCache appianCache_) Adds the primary keys of the Appian-typed objects maintained by the elements in the given array to the cache.Gets the child processes of this process, if this process contains sub or linked processes;null
otherwise.Gets the user who has this process locked.Gets the time at which the process was most recently locked.Gets the parent processes of this process, if this process is a sub or linked process;null
otherwise.Gets the id of the process whose diagram is represented.Gets the nodes of the process whose diagram is featured here.Gets the permissions associated to the process instance represented by this process diagramGets the UUID in the Elastic Engine for this process.Gets the runtime name of this process, as generated by the process execution engine.Deprecated.use getProcessNodesGets the status of the process whose diagram is featured here.Deprecated.use getVariablesGets the process variables of the process whose diagram is featured here.void
setChildProcesses
(ProcessSummary[] childProcesses_) Sets the child processes of this process, if this process contains sub or linked processes;null
otherwise.void
setLockedBy
(String processLockedBy_) Sets the user who has this process locked.void
setLockedTime
(Timestamp processLockedTime_) Sets the time at which the process was most recently locked.void
setParentProcesses
(ProcessSummary[] parentProcesses_) Sets the parent processes of this process, if this process is a sub or linked process;null
otherwise.void
setProcessId
(Long id_) Sets the id of the process whose diagram is represented.void
setProcessNodes
(RuntimeProcessNode[] processNodes_) Sets the nodes of the process whose diagram is featured here.void
setProcessPermissions
(ProcessPermissions processPermissions_) Sets the permissions associated to the process instance represented by this process diagramvoid
setProcessUuid
(String processUuid) Sets the UUID in the Elastic Engine for this process.void
setRuntimeProcessName
(String runtimeProcessName_) Sets the runtime name of this process.void
setRuntimeProcessNodes
(RuntimeProcessNode[] processNodes_) void
Sets the status of the process whose diagram is featured here.void
setVariableInstances
(ProcessVariableInstance[] variables_) Deprecated.use setVariablesvoid
setVariables
(ProcessVariableInstance[] variables_) Sets the process variables of the process whose diagram is featured here.Methods inherited from class com.appiancorp.suiteapi.process.AbstractProcessModel
fillInAppianTypes, getAcSchemas, getAnnotations, getAttachments, getAutoArchiveDelay, getAutoDeleteDelay, getCleanupAction, getCreatorUsername, getDeadline, getDefaultProcessSecurity, getDescription, getEmailAttachmentFolderId, getEpexValidated, getExecutionEnvironment, getFolderId, getFormConfig, getFormConfigMap, getGroupOwnerId, getHiddenAttributes, getIsPublic, getLanes, getLastModifiedUsername, getLatestVersion, getLockedByTime, getNotes, getNotesWithContent, getNtfSettings, getOwnerUsername, getPermissions, getPriority, getProcessName, getSchedules, getSecurity, getState, getTargetCompletion, getTimeStampCreated, getTimeStampUpdated, getTimeZoneId, getUuid, getVersion, getVersionStatus, isEnabled, isModified, isMutablePriority, isUseProcessInitiatorTimeZone, isValidated, setAcSchemas, setAnnotations, setAttachments, setAutoArchiveDelay, setAutoDeleteDelay, setCleanupAction, setCreatorUsername, setDeadline, setDefaultProcessSecurity, setDescription, setEmailAttachmentFolderId, setEnabled, setEpexValidated, setExecutionEnvironment, setFolderId, setFormConfigMap, setGroupOwnerId, setIsPublic, setLanes, setLastModifiedUsername, setLatestVersion, setLockedByTime, setModified, setMutablePriority, setNotes, setNtfSettings, setOwnerUsername, setPermissions, setPriority, setProcessName, setSchedules, setSecurity, setState, setTargetCompletion, setTimeStampCreated, setTimeStampUpdated, setTimeZoneId, setUseProcessInitiatorTimeZone, setUuid, setValidated, setVersion, setVersionStatus
-
Constructor Details
-
ProcessDiagram
public ProcessDiagram()
-
-
Method Details
-
getChildProcesses
Gets the child processes of this process, if this process contains sub or linked processes;null
otherwise. Used for breadcrumbs for child processes in the interface; Only contains processes that the user can see.- Returns:
- summaries of the child processes.
-
setChildProcesses
Sets the child processes of this process, if this process contains sub or linked processes;null
otherwise. Used for breadcrumbs for child processes in the interface; Only contains processes that the user can see.- Parameters:
childProcesses_
- summaries of the child processes.
-
getParentProcesses
Gets the parent processes of this process, if this process is a sub or linked process;null
otherwise. Used for breadcrumbs to parent processes in the interface. Only contains processes that the user can see.- Returns:
- summaries of the parent processes.
-
setParentProcesses
Sets the parent processes of this process, if this process is a sub or linked process;null
otherwise. Used for breadcrumbs to parent processes in the interface. Only contains processes that the user can see.- Parameters:
parentProcesses_
- summaries of the parent processes.
-
getProcessId
Gets the id of the process whose diagram is represented.- Returns:
- the id of the process whose diagram is represented.
-
setProcessId
Sets the id of the process whose diagram is represented.- Parameters:
id_
- the id of the process whose diagram is represented.
-
getRuntimeProcessNodes
Deprecated.use getProcessNodesGets the nodes of the process whose diagram is featured here.- Returns:
- the nodes of the process whose diagram is featured here.
-
getProcessNodes
Gets the nodes of the process whose diagram is featured here.- Returns:
- the nodes of the process whose diagram is featured here.
-
setProcessNodes
Sets the nodes of the process whose diagram is featured here.- Parameters:
processNodes_
- the nodes of the process whose diagram is featured here.
-
setRuntimeProcessNodes
-
getVariableInstances
Deprecated.use getVariablesGets the process variables of the process whose diagram is featured here.- Returns:
- the process variables of the process whose diagram is featured here.
-
setVariableInstances
Deprecated.use setVariablesSets the process variables of the process whose diagram is featured here.- Parameters:
variables_
- the process variables of the process whose diagram is featured here.
-
getVariables
Gets the process variables of the process whose diagram is featured here.- Returns:
- the process variables of the process whose diagram is featured here.
-
setVariables
Sets the process variables of the process whose diagram is featured here.- Parameters:
variables_
- the process variables of the process whose diagram is featured here.
-
getLockedBy
Gets the user who has this process locked.- Overrides:
getLockedBy
in classAbstractProcessModel
- Returns:
- the username of the user who has this process locked, or
null
if the process is not locked.
-
setLockedBy
Sets the user who has this process locked.- Overrides:
setLockedBy
in classAbstractProcessModel
- Parameters:
processLockedBy_
- the username of the user who has this process locked, ornull
if the process is not locked.
-
getLockedTime
Gets the time at which the process was most recently locked.- Returns:
- the time at which the process was most recently locked,
or
null
if the process is not currently locked.
-
setLockedTime
Sets the time at which the process was most recently locked.- Parameters:
processLockedTime_
- the time at which the process was most recently locked, ornull
if the process is not currently locked.
-
getStatus
Gets the status of the process whose diagram is featured here.- Returns:
- one of the
STATUS_XXX
constants fromProcessModel
.
-
setStatus
Sets the status of the process whose diagram is featured here.- Parameters:
status_
- one of theSTATUS_XXX
constants fromProcessModel
.
-
getProcessPermissions
Gets the permissions associated to the process instance represented by this process diagram- Returns:
- Returns the processPermissions.
-
setProcessPermissions
Sets the permissions associated to the process instance represented by this process diagram- Parameters:
processPermissions_
- The processPermissions to set.
-
fillInAppianTypes
Description copied from class:AbstractProcessModel
Adds the primary keys of the Appian-typed objects maintained by the elements in the given array to the cache. This method is cheap.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Overrides:
fillInAppianTypes
in classAbstractProcessModel
- Parameters:
appianCache_
- cache of Appian-typed objects.
-
getRuntimeProcessName
Gets the runtime name of this process, as generated by the process execution engine.- Returns:
- The runtime name of this process.
-
setRuntimeProcessName
Sets the runtime name of this process.- Parameters:
runtimeProcessName_
- The runtime name of this process to set.
-
setProcessUuid
Sets the UUID in the Elastic Engine for this process.- Parameters:
processUuid
- the uuid to set
-
getProcessUuid
Gets the UUID in the Elastic Engine for this process.- Returns:
- this process' UUID
-