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, java.io.Serializable

public class ProcessDiagram
extends AbstractProcessModel

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:

Serialized Form

Field Summary

Fields inherited from class com.appiancorp.suiteapi.process.AbstractProcessModel

AUTO_ARCHIVE, AUTO_DELETE, DEFAULT_COMPLETION, 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

Constructors

Constructor and Description
ProcessDiagram()

Method Summary

Modifier and Type	Method and Description
void	fillInAppianTypes(AppianTypeCache appianCache_) Adds the primary keys of the Appian-typed objects maintained by the elements in the given array to the cache.
ProcessSummary[]	getChildProcesses() Gets the child processes of this process, if this process contains sub or linked processes; null otherwise.
java.lang.String	getLockedBy() Gets the user who has this process locked.
java.sql.Timestamp	getLockedTime() Gets the time at which the process was most recently locked.
ProcessSummary[]	getParentProcesses() Gets the parent processes of this process, if this process is a sub or linked process; null otherwise.
java.lang.Long	getProcessId() Gets the id of the process whose diagram is represented.
RuntimeProcessNode[]	getProcessNodes() Gets the nodes of the process whose diagram is featured here.
ProcessPermissions	getProcessPermissions() Gets the permissions associated to the process instance represented by this process diagram
java.lang.String	getRuntimeProcessName() Gets the runtime name of this process, as generated by the process execution engine.
RuntimeProcessNode[]	getRuntimeProcessNodes() Deprecated. use getProcessNodes
java.lang.Integer	getStatus() Gets the status of the process whose diagram is featured here.
ProcessVariableInstance[]	getVariableInstances() Deprecated. use getVariables
ProcessVariableInstance[]	getVariables() Gets 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(java.lang.String processLockedBy_) Sets the user who has this process locked.
void	setLockedTime(java.sql.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(java.lang.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 diagram
void	setRuntimeProcessName(java.lang.String runtimeProcessName_) Sets the runtime name of this process.
void	setRuntimeProcessNodes(RuntimeProcessNode[] processNodes_)
void	setStatus(java.lang.Integer status_) Sets the status of the process whose diagram is featured here.
void	setVariableInstances(ProcessVariableInstance[] variables_) Deprecated. use setVariables
void	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, 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, 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

Methods inherited from class com.appiancorp.suiteapi.common.LocalizedIdentity

equals, getId, getIds, getName, hashCode, setId, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessDiagram

public ProcessDiagram()

Method Detail

getChildProcesses

public ProcessSummary[] 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

public void setChildProcesses(ProcessSummary[] childProcesses_)

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

public ProcessSummary[] 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

public void setParentProcesses(ProcessSummary[] parentProcesses_)

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

public java.lang.Long getProcessId()

Gets the id of the process whose diagram is represented.

Returns:

the id of the process whose diagram is represented.

setProcessId

public void setProcessId(java.lang.Long id_)

Sets the id of the process whose diagram is represented.

Parameters:

id_ - the id of the process whose diagram is represented.

getRuntimeProcessNodes

public RuntimeProcessNode[] getRuntimeProcessNodes()

Deprecated. use getProcessNodes

Gets the nodes of the process whose diagram is featured here.

Returns:

the nodes of the process whose diagram is featured here.

getProcessNodes

public RuntimeProcessNode[] getProcessNodes()

Gets the nodes of the process whose diagram is featured here.

Returns:

the nodes of the process whose diagram is featured here.

setProcessNodes

public void setProcessNodes(RuntimeProcessNode[] processNodes_)

Sets the nodes of the process whose diagram is featured here.

Parameters:

processNodes_ - the nodes of the process whose diagram is featured here.

setRuntimeProcessNodes

public void setRuntimeProcessNodes(RuntimeProcessNode[] processNodes_)

getVariableInstances

public ProcessVariableInstance[] getVariableInstances()

Deprecated. use 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.

setVariableInstances

public void setVariableInstances(ProcessVariableInstance[] variables_)

Deprecated. use 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.

getVariables

public ProcessVariableInstance[] 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

public void setVariables(ProcessVariableInstance[] variables_)

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

public java.lang.String getLockedBy()

Gets the user who has this process locked.

Overrides:

getLockedBy in class AbstractProcessModel

Returns:

the username of the user who has this process locked, or null if the process is not locked.

setLockedBy

public void setLockedBy(java.lang.String processLockedBy_)

Sets the user who has this process locked.

Overrides:

setLockedBy in class AbstractProcessModel

Parameters:

processLockedBy_ - the username of the user who has this process locked, or null if the process is not locked.

getLockedTime

public java.sql.Timestamp 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

public void setLockedTime(java.sql.Timestamp processLockedTime_)

Sets the time at which the process was most recently locked.

Parameters:

processLockedTime_ - the time at which the process was most recently locked, or null if the process is not currently locked.

getStatus

public java.lang.Integer getStatus()

Gets the status of the process whose diagram is featured here.

Returns:

one of the STATUS_XXX constants from ProcessModel.

setStatus

public void setStatus(java.lang.Integer status_)

Sets the status of the process whose diagram is featured here.

Parameters:

status_ - one of the STATUS_XXX constants from ProcessModel.

getProcessPermissions

public ProcessPermissions getProcessPermissions()

Gets the permissions associated to the process instance represented by this process diagram

Returns:

Returns the processPermissions.

setProcessPermissions

public void setProcessPermissions(ProcessPermissions processPermissions_)

Sets the permissions associated to the process instance represented by this process diagram

Parameters:

processPermissions_ - The processPermissions to set.

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache appianCache_)

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 interface AppianTypeHolder

Overrides:

fillInAppianTypes in class AbstractProcessModel

Parameters:

appianCache_ - cache of Appian-typed objects.

getRuntimeProcessName

public java.lang.String getRuntimeProcessName()

Gets the runtime name of this process, as generated by the process execution engine.

Returns:

The runtime name of this process.

setRuntimeProcessName

public void setRuntimeProcessName(java.lang.String runtimeProcessName_)

Sets the runtime name of this process.

Parameters:

runtimeProcessName_ - The runtime name of this process to set.