Package com.appiancorp.suiteapi.process
Class ProcessStartConfig
java.lang.Object
com.appiancorp.suiteapi.process.ProcessStartConfig
Specifies options and configurations that control behavior when starting a process.
-
Constructor Summary
ConstructorDescriptionInstantiate aProcessStartConfig
using default values for all configurations.ProcessStartConfig
(ProcessVariable[] processParameters) Instantiate aProcessStartConfig
with the given process parameters.ProcessStartConfig
(ProcessVariable[] processParameters, String processModelVersion, Long priorityId) Instantiate aProcessStartConfig
with the given process parameters, process model version and priority id.ProcessStartConfig
(ProcessVariable[] processParameters, String processModelVersion, Long priorityId, int depth) Instantiate aProcessStartConfig
with the given process parameters, process model version and priority id. -
Method Summary
Modifier and TypeMethodDescriptionint
getDepth()
Get the depth of the current processGet the priority id to use when starting the process.Get the process model version to use when starting the process.Get the process parameters that will be used when starting the process.void
setDepth
(int depth) Set the current process depthvoid
setPriorityId
(Long priorityId) Set the priority id to use when starting the process.void
setProcessModelVersion
(String processModelVersion) Set the process model version to use when starting the process.void
setProcessParameters
(ProcessVariable[] processParameters) Set the process parameters to use when starting the process.
-
Constructor Details
-
ProcessStartConfig
public ProcessStartConfig()Instantiate aProcessStartConfig
using default values for all configurations. -
ProcessStartConfig
Instantiate aProcessStartConfig
with the given process parameters. Default values will be used for all other configurations.- Parameters:
processParameters
- The process parameters to use when starting the process. The following fields must be populated for eachProcessVariable
object:name
,value
,instanceType
.
-
ProcessStartConfig
public ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId) Instantiate aProcessStartConfig
with the given process parameters, process model version and priority id.- Parameters:
processParameters
- The process parameters to use when starting the process. The following fields must be populated for eachProcessVariable
object:name
,value
,instanceType
.processModelVersion
- The process model version to use when starting the process (useAbstractProcessModel.LATEST_PUBLISHED_VERSION
to start the latest published version of the model)priorityId
- The priority id to use when starting the process (null means use the default).
-
ProcessStartConfig
public ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId, int depth) Instantiate aProcessStartConfig
with the given process parameters, process model version and priority id.- Parameters:
processParameters
- The process parameters to use when starting the process. The following fields must be populated for eachProcessVariable
object:name
,value
,instanceType
.processModelVersion
- The process model version to use when starting the process (useAbstractProcessModel.LATEST_PUBLISHED_VERSION
to start the latest published version of the model)priorityId
- The priority id to use when starting the process (null means use the default).depth
- The current subprocess depth. Top level is 0
-
-
Method Details
-
getPriorityId
Get the priority id to use when starting the process. Defaults to null, which means use the default priority id.- Returns:
- the priority id
-
setPriorityId
Set the priority id to use when starting the process.- Parameters:
priorityId
- the priority id (null means use the default)
-
getProcessModelVersion
Get the process model version to use when starting the process. Defaults to the latest published version if not set.- Returns:
- the process model version
-
setProcessModelVersion
Set the process model version to use when starting the process.- Parameters:
processModelVersion
- the process model version (useAbstractProcessModel.LATEST_PUBLISHED_VERSION
to start the latest published version of the model)
-
getProcessParameters
Get the process parameters that will be used when starting the process.- Returns:
- the process parameters
-
setProcessParameters
Set the process parameters to use when starting the process. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable aUser
object. Instead, assign that process variable aString
containing the username. Likewise, assign a process variable of type Group should be assigned aLong
, etc. The exception to this rule is the People type. Process variables of type People should be assigned aLocalObject
. Only the values are used for passed parameters, not expressions; expressions must be set on the process model at design time.- Parameters:
processParameters
- The following fields must be populated for eachProcessVariable
object:name
,value
,instanceType
-
getDepth
public int getDepth()Get the depth of the current process- Returns:
- the current depth
-
setDepth
public void setDepth(int depth) Set the current process depth- Parameters:
depth
- the current process depth
-