ActivityExecutionMetadata (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.framework.ActivityExecutionMetadata

All Implemented Interfaces:

java.io.Serializable
```
public class ActivityExecutionMetadata
extends java.lang.Object
implements java.io.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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActivityExecutionMetadata()

Constructors
Constructor and Description
`ActivityExecutionMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivityProperties`	`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.
`java.util.Map<java.lang.String,java.lang.String>`	`getAdditionalContext()` A map of additional context that is passed to the node from an external service.
`java.lang.String`	`getConfirmationUrl()` Gets the url of the page that should be shown to the user who performs an attended task if that task completes successfully.
`java.lang.Integer`	`getExecutionEnvironment()` The environment in which the activity executes, such as process execution engine or java.
`FormConfig`	`getForm()`
`java.lang.String`	`getHelper()`
`ActivityParameterHelper`	`getHelperInstance()`
`java.lang.Long`	`getId()`
`java.lang.String`	`getJavaActivityClassname()` Gets the fully qualified class name of the java class that embodies the activity.
`ActivityClassParameter[]`	`getParameters()` Gets the input parameters on which the activity operates.
`int`	`getPrecedingChainedActivity()`
`ActivityReturnVariable[]`	`getReturnVariables()` Gets the variables whose values are produced during activity execution.
`java.lang.String`	`getUser()` The user who executes the activity
`java.lang.Long`	`getWorkId()` Gets the workId of an activity if it's managed by the workq, null otherwise.
`boolean`	`hasPrecedingChainedActivity()`
`boolean`	`isAsynchronous()`
`boolean`	`isBackButtonEnabled()`
`boolean`	`isChained()`
`boolean`	`isFormDeleted()`
`boolean`	`isLingering()` Returns `true` if this is a Quick Task, `false` otherwise.
`boolean`	`isOnCompleteKeepFormData()`
`void`	`setActivityProperties(ActivityProperties activityProperties_)`
`void`	`setAdditionalContext(java.util.Map<java.lang.String,java.lang.String> additionalContext_)`
`void`	`setAsynchronous(boolean asynchronous_)`
`void`	`setBackButtonEnabled(boolean backButtonEnabled_)`
`void`	`setChained(boolean chained_)`
`void`	`setConfirmationUrl(java.lang.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(java.lang.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`	`setHelper(java.lang.String helper_)`
`void`	`setId(java.lang.Long id_)`
`void`	`setJavaActivityClassname(java.lang.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`	`setUser(java.lang.String _user)` The user who executes the activity
`void`	`setWorkId(java.lang.Long workId_)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ActivityExecutionMetadata
```
public ActivityExecutionMetadata()
```
- Method Detail
  - getId
```
public java.lang.Long getId()
```
  - setId
```
public void setId(java.lang.Long id_)
```
  - getExecutionEnvironment
```
public java.lang.Integer 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:
    
    ActivityClassSchema
  - setExecutionEnvironment
```
public void setExecutionEnvironment(java.lang.Integer executionEnvironment_)
```
    The environment in which the activity executes, such as process execution engine or java.
    
    Parameters:
    
    executionEnvironment_ - one of the ActivityClassSchema.ENVIRONMENT_XXX constants.
    
    See Also:
    
    ActivityClassSchema
  - getJavaActivityClassname
```
public java.lang.String 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
```
public void setJavaActivityClassname(java.lang.String javaActivityClassname_)
```
    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
```
public ActivityClassParameter[] getParameters()
```
    Gets the input parameters on which the activity operates.
    
    Returns:
    
    the parameters
  - setParameters
```
public void setParameters(ActivityClassParameter[] parameters_)
```
    Sets the input parameters on which the activity operates.
  - getConfirmationUrl
```
public java.lang.String 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
```
public void setConfirmationUrl(java.lang.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.
  - getReturnVariables
```
public ActivityReturnVariable[] getReturnVariables()
```
    Gets the variables whose values are produced during activity execution. These values are then stored in the database via a call to ProcessExecutionService.completeActivity.
    
    Returns:
    
    the results from the execution of the activity
    
    See Also:
    
    SafeActivityReturnVariable
  - setReturnVariables
```
public void setReturnVariables(ActivityReturnVariable[] returnVariables_)
```
    The variables whose values are produced during activity execution. These values are then stored in the database via a call to ProcessExecutionService.completeActivity.
  - getUser
```
public java.lang.String getUser()
```
    The user who executes the activity
    
    Returns:
    
    the username of the user who executes the activity.
  - setUser
```
public void setUser(java.lang.String _user)
```
    The user who executes the activity
    
    Parameters:
    
    _user - the primary key (username) of the user.
  - getActivityProperties
```
public ActivityProperties 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:
    
    TaskProperties, ProcessProperties, ProcessModelProperties
  - setActivityProperties
```
public void setActivityProperties(ActivityProperties activityProperties_)
```
  - getWorkId
```
public java.lang.Long getWorkId()
```
    Gets the workId of an activity if it's managed by the workq, null otherwise.
  - setWorkId
```
public void setWorkId(java.lang.Long workId_)
```
  - getForm
```
public FormConfig 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:
    
    InternalForm, DynamicForm, JSPForm
  - setForm
```
public void setForm(FormConfig form_)
```
  - getHelperInstance
```
public ActivityParameterHelper getHelperInstance()
```
    Returns:
    
    the instantiated Helper class for the activity
  - setHelper
```
public void setHelper(java.lang.String helper_)
```
  - getHelper
```
public java.lang.String getHelper()
```
    Returns:
    
    fully qualified name of the helper class.
  - isAsynchronous
```
public boolean isAsynchronous()
```
    Returns:
    
    true if the activity is asynchronous else false. 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()
```
    Returns true 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
```
public java.util.Map<java.lang.String,java.lang.String> getAdditionalContext()
```
    A map of additional context that is passed to the node from an external service. This item can be null
  - setAdditionalContext
```
public void setAdditionalContext(java.util.Map<java.lang.String,java.lang.String> additionalContext_)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ActivityExecutionMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActivityExecutionMetadata

Method Detail

getId

setId

getExecutionEnvironment

setExecutionEnvironment

getJavaActivityClassname

setJavaActivityClassname

getParameters

setParameters

getConfirmationUrl

setConfirmationUrl

getReturnVariables

setReturnVariables

getUser

setUser

getActivityProperties

setActivityProperties

getWorkId

setWorkId

getForm

setForm

getHelperInstance

setHelper

getHelper

isAsynchronous

setAsynchronous

getPrecedingChainedActivity

hasPrecedingChainedActivity

setPrecedingChainedActivity

isChained

setChained

isLingering

setLingering

isBackButtonEnabled

setBackButtonEnabled

isFormDeleted

setFormDeleted

isOnCompleteKeepFormData

setOnCompleteKeepFormData

getAdditionalContext

setAdditionalContext

toString