Package com.appiancorp.suiteapi.process.framework

Class ActivityExecutionMetadata

java.lang.Object
com.appiancorp.suiteapi.process.framework.ActivityExecutionMetadata
All Implemented Interfaces:
Serializable
public class ActivityExecutionMetadata extends Object implements 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 Details

    • ActivityExecutionMetadata

      public ActivityExecutionMetadata()

  • Method Details

    • getId

      public Long getId()

    • setId

      public void setId(Long id_)

    • getToken

      public Integer getToken()
      Returns:
      Token to be passed along from the creation of this ActivityExecutionMetadata until its use.

    • setToken

      public void setToken(Integer token)
      Token to be passed along from the creation of this ActivityExecutionMetadata until its use.
      Parameters:
      token -

    • getExecutionEnvironment

      public 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:

    • setExecutionEnvironment

      public void setExecutionEnvironment(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:

    • getOutputExpressions

      public String[] getOutputExpressions()
      Returns:
      output expressions for the activity, which are full expressions to be evaluated in context of the completed activity. Non-null.

    • setOutputExpressions

      public void setOutputExpressions(String[] outputExpressions)
      Parameters:
      outputExpressions - the output expressions or the activity, which are full expressions to be evaluated in context of the completed activity.

    • getJavaActivityClassname

      public 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(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 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(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:

    • 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 String getUser()
      The user who executes the activity
      Returns:
      the username of the user who executes the activity.

    • setUser

      public void setUser(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:

    • setActivityProperties

      public void setActivityProperties(ActivityProperties activityProperties_)

    • getWorkId

      public Long getWorkId()
      Gets the workId of an activity if it's managed by the workq, null otherwise.

    • setWorkId

      public void setWorkId(Long workId_)

    • getWorkToken

      public Long getWorkToken()
      Gets the unique disambiguation token of an activity if it's managed by the workq, null otherwise

    • setWorkToken

      public void setWorkToken(Long _workToken)

    • getWorkType

      public Long getWorkType()
      Gets the work type code of an activity if it's managed by the workq, null otherwise

    • setWorkType

      public void setWorkType(Long workType)

    • getGrantorUsername

      public String getGrantorUsername()

    • setGrantorUsername

      public void setGrantorUsername(String grantorUsername)

    • 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:

    • setForm

      public void setForm(FormConfig form_)

    • getHelperInstance

      public ActivityParameterHelper getHelperInstance()
      Returns:
      the instantiated Helper class for the activity

    • setHelper

      public void setHelper(String helper_)

    • getHelper

      public 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_)

    • getChainingTimeout

      public Timestamp getChainingTimeout()

    • setChainingTimeout

      public void setChainingTimeout(Timestamp chainingTimeout)

    • 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 Map<String,String> getAdditionalContext()
      A map of additional context that is passed to the node from an external service. This item can be null

    • setAdditionalContext

      @Deprecated public void setAdditionalContext(Map<String,String> additionalContext_)
      Deprecated.
      see addAdditionalContext to not displace existing context
      Parameters:
      additionalContext_ -

    • addAdditionalContext

      public void addAdditionalContext(String key, String value)
      Add additional context passed to the node from an external service, displacing only an item with the same key.
      Parameters:
      key -
      value -

    • addAdditionalContext

      public void addAdditionalContext(Map<String,String> additionalContext)
      Add additional context passed to the node from an external service, displacing only items with the same key.
      Parameters:
      additionalContext -

    • getAsyncState

      public int getAsyncState()

    • setAsyncState

      public void setAsyncState(int asyncStateCode)

    • toString

      public String toString()
      Overrides:
      toString in class Object