com.appiancorp.suiteapi.process

Class ProcessModel

java.lang.Object

com.appiancorp.suiteapi.common.LocalizedIdentity

com.appiancorp.suiteapi.process.AbstractProcessModel

com.appiancorp.suiteapi.process.ProcessModel

All Implemented Interfaces:

JSONable, JSONCacheable, AppianTypeHolder, java.io.Serializable

public class ProcessModel
extends AbstractProcessModel

The template from which processes are created. A process model contains nodes that are connected to each other through flows (aka connections). Each node represents an activity to be performed by either the system or a user. Nodes have one primary activity, but can have an arbitrary number of pre- and post-activities, as long as such activities are unattended (i.e. do not require user interaction). The process model also holds such meta data as who created it, when, and what group the model is associated with. Process models are generally created through the UI designer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessModel.Descriptor Inner class that holds the name, id, and description of a process model.

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
ProcessModel()

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.
java.lang.Long[]	getDatatypeReferences() Gets the list of data types referenced by this model.
ProcessModelLogging	getLogging()
ProcessNode[]	getProcessNodes() Gets the nodes that this model comprises.
ProcessVariable[]	getVariables() Gets the list of process variables used by this model.
void	resetNodesUUIDsAndEventPersistentIds() Resets the UUID of each node and the persistentId of each event in this process model to null, so that the database will generate new UUIDs/ids the next time the process model is saved.
void	setDatatypeReferences(java.lang.Long[] datatypeReferences_) Sets the data types referenced by this model.
void	setLogging(ProcessModelLogging _logging)
void	setProcessNodes(ProcessNode[] processNodes_) Sets the nodes that this model comprises.
void	setVariables(ProcessVariable[] variables_) Sets the process variables for this model.
void	sortVariables()
java.lang.String	toString() Generates a string representation of this model for debugging.
void	updateFromDescriptor(ProcessModel.Descriptor src_)

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, getLockedBy, 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, setLockedBy, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessModel

public ProcessModel()

Method Detail

getProcessNodes

public ProcessNode[] getProcessNodes()

Gets the nodes that this model comprises.

Returns:

the process nodes contained in the process model

setProcessNodes

public void setProcessNodes(ProcessNode[] processNodes_)

Sets the nodes that this model comprises.

Parameters:

processNodes_ - an array of the nodes in this model.

getVariables

public ProcessVariable[] getVariables()

Gets the list of process variables used by this model.

Returns:

the process variables of this model.

sortVariables

public void sortVariables()

setVariables

public void setVariables(ProcessVariable[] variables_)

Sets the process variables for this model.

Parameters:

variables_ - the process variables used by this model.

setDatatypeReferences

public void setDatatypeReferences(java.lang.Long[] datatypeReferences_)

Sets the data types referenced by this model. The data types are set by the system when this bean is returned. Calling this method has no effect.

Parameters:

datatypeReferences_ - the data types referenced by this model.

getDatatypeReferences

public java.lang.Long[] getDatatypeReferences()

Gets the list of data types referenced by this model.

Returns:

the data types referenced by this model.

getLogging

public ProcessModelLogging getLogging()

Returns:

ProcessModelLogging of this model.

setLogging

public void setLogging(ProcessModelLogging _logging)

Parameters:

_logging - the ProcessModelLogging used by this model.

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.

updateFromDescriptor

public void updateFromDescriptor(ProcessModel.Descriptor src_)

toString

public java.lang.String toString()

Generates a string representation of this model for debugging.

Overrides:

toString in class LocalizedIdentity

Returns:

String representation of the object

resetNodesUUIDsAndEventPersistentIds

public void resetNodesUUIDsAndEventPersistentIds()

Resets the UUID of each node and the persistentId of each event in this process model to null, so that the database will generate new UUIDs/ids the next time the process model is saved.