Class ActivityExecutionMetadata
java.lang.Object
com.appiancorp.suiteapi.process.framework.ActivityExecutionMetadata
- All Implemented Interfaces:
Serializable
Metadata attributes of an activity that are needed during its execution. Generally, these objects
are retrieved from API calls on the ProcessExecutionService, so developers should not interact
with the setter methods.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the properties of an activity, such as the task properties, process properties, and process model properties for a task, the process it is in, and the model for that process.A map of additional context that is passed to the node from an external service.Gets the url of the page that should be shown to the user who performs an attended task if that task completes successfully.The environment in which the activity executes, such as process execution engine or java.getForm()
getId()
Gets the fully qualified class name of the java class that embodies the activity.Gets the input parameters on which the activity operates.int
Gets the variables whose values are produced during activity execution.getUser()
The user who executes the activityGets the workId of an activity if it's managed by the workq, null otherwise.Gets the unique disambiguation token of an activity if it's managed by the workq, null otherwiseGets the work type code of an activity if it's managed by the workq, null otherwiseboolean
boolean
boolean
boolean
boolean
boolean
Returnstrue
if this is a Quick Task,false
otherwise.boolean
void
setActivityProperties
(ActivityProperties activityProperties_) void
setAdditionalContext
(Map<String, String> additionalContext_) void
setAsynchronous
(boolean asynchronous_) void
setBackButtonEnabled
(boolean backButtonEnabled_) void
setChained
(boolean chained_) void
setConfirmationUrl
(String confirmationUrl_) Sets the url of the page that should be shown to the user who performs an attended task if that task completes successfully.void
setExecutionEnvironment
(Integer executionEnvironment_) The environment in which the activity executes, such as process execution engine or java.void
setForm
(FormConfig form_) void
setFormDeleted
(boolean formDeleted_) void
setGrantorUsername
(String grantorUsername) void
void
void
setJavaActivityClassname
(String javaActivityClassname_) Sets the fully qualified class name of the java class that embodies the activity.void
setLingering
(boolean lingering_) void
setOnCompleteKeepFormData
(boolean onCompleteKeepFormData_) void
setParameters
(ActivityClassParameter[] parameters_) Sets the input parameters on which the activity operates.void
setPrecedingChainedActivity
(int precedingChainedActivity_) void
setReturnVariables
(ActivityReturnVariable[] returnVariables_) The variables whose values are produced during activity execution.void
The user who executes the activityvoid
void
setWorkToken
(Long _workToken) void
setWorkType
(Long workType) toString()
-
Constructor Details
-
ActivityExecutionMetadata
public ActivityExecutionMetadata()
-
-
Method Details
-
getId
-
setId
-
getExecutionEnvironment
The environment in which the activity executes, such as process execution engine or java.- Returns:
- one of the
ActivityClassSchema.ENVIRONMENT_XXX
constants. - See Also:
-
setExecutionEnvironment
The environment in which the activity executes, such as process execution engine or java.- Parameters:
executionEnvironment_
- one of theActivityClassSchema.ENVIRONMENT_XXX
constants.- See Also:
-
getJavaActivityClassname
Gets the fully qualified class name of the java class that embodies the activity. This method is only useful if the execution environment is Java.- Returns:
- the activity class name
-
setJavaActivityClassname
Sets the fully qualified class name of the java class that embodies the activity. This method is only useful if the execution environment is Java. -
getParameters
Gets the input parameters on which the activity operates.- Returns:
- the parameters
-
setParameters
Sets the input parameters on which the activity operates. -
getConfirmationUrl
Gets the url of the page that should be shown to the user who performs an attended task if that task completes successfully.- Returns:
- the confirmation page
-
setConfirmationUrl
Sets the url of the page that should be shown to the user who performs an attended task if that task completes successfully. -
getReturnVariables
Gets the variables whose values are produced during activity execution. These values are then stored in the database via a call toProcessExecutionService.completeActivity
.- Returns:
- the results from the execution of the activity
- See Also:
-
setReturnVariables
The variables whose values are produced during activity execution. These values are then stored in the database via a call toProcessExecutionService.completeActivity
. -
getUser
The user who executes the activity- Returns:
- the username of the user who executes the activity.
-
setUser
The user who executes the activity- Parameters:
_user
- the primary key (username) of the user.
-
getActivityProperties
Gets the properties of an activity, such as the task properties, process properties, and process model properties for a task, the process it is in, and the model for that process.- Returns:
- the properties
- See Also:
-
setActivityProperties
-
getWorkId
Gets the workId of an activity if it's managed by the workq, null otherwise. -
setWorkId
-
getWorkToken
Gets the unique disambiguation token of an activity if it's managed by the workq, null otherwise -
setWorkToken
-
getWorkType
Gets the work type code of an activity if it's managed by the workq, null otherwise -
setWorkType
-
getGrantorUsername
-
setGrantorUsername
-
getForm
- Returns:
- the form configuration object which will specify the form that will be used for the activity. Forms can be internal, JSP or dynamic
- See Also:
-
setForm
-
getHelperInstance
- Returns:
- the instantiated Helper class for the activity
-
setHelper
-
getHelper
- Returns:
- fully qualified name of the helper class.
-
isAsynchronous
public boolean isAsynchronous()- Returns:
true
if the activity is asynchronous elsefalse
. Asynchronous activities do not stall the Process Execution Engine
-
setAsynchronous
public void setAsynchronous(boolean asynchronous_) -
getPrecedingChainedActivity
public int getPrecedingChainedActivity() -
hasPrecedingChainedActivity
public boolean hasPrecedingChainedActivity() -
setPrecedingChainedActivity
public void setPrecedingChainedActivity(int precedingChainedActivity_) -
isChained
public boolean isChained() -
setChained
public void setChained(boolean chained_) -
isLingering
public boolean isLingering()Returnstrue
if this is a Quick Task,false
otherwise.- Returns:
true
if it's a Quick Task,false
otherwise.
-
setLingering
public void setLingering(boolean lingering_) -
isBackButtonEnabled
public boolean isBackButtonEnabled() -
setBackButtonEnabled
public void setBackButtonEnabled(boolean backButtonEnabled_) -
isFormDeleted
public boolean isFormDeleted() -
setFormDeleted
public void setFormDeleted(boolean formDeleted_) -
isOnCompleteKeepFormData
public boolean isOnCompleteKeepFormData() -
setOnCompleteKeepFormData
public void setOnCompleteKeepFormData(boolean onCompleteKeepFormData_) -
getAdditionalContext
A map of additional context that is passed to the node from an external service. This item can be null -
setAdditionalContext
-
toString
-