patExecContext reference

This section describes the methods that the patExecContext object provides.

getProcessId

Gets the identifier of the process instance that is currently being executed.

Syntax 

getProcessId()

Returns

A long value that contains the process identifier.

getBranchId

Gets the identifier of the branch instance that is currently being executed.

Syntax 

getBranchId()

Returns

A long value that contains the branch identifier.

getActionId

Gets the identifier of the operation instance that is currently being executed.

Syntax 

getActionId()

Returns

A long value that contains the operation instance identifier.

getExecuteTemplate

Gets the action to be executed and casts it to an ExecuteTemplate.

Syntax 

public ExecuteTemplate getExecuteTemplate()

getActionTemplate

Gets the action to be executed.

Syntax 

public ActionTemplate getActionTemplate()

See also

com.adobe.workflow.template.document.ActionTemplate[Should this be a link?]

getProcessDataBooleanValue

Gets the process data value from the specified path as a boolean value.

Syntax 

getProcessDataBooleanValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the boolean value in the process data model.

Returns

A boolean value coerced from the specified expression that represents a process data path.

getProcessDataShortValue

Gets the process data value from the specified path as a short value.

Syntax 

getProcessDataShortValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the short value in the process data model.

Returns

A short value coerced from the specified expression that represents a process data path.

getProcessDataIntValue

Gets the process data value from the specified path as an int value.

Syntax 

getProcessDataIntValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the int value in the process data model.

Returns

An int value coerced from the specified expression that represents a process data path.

getProcessDataLongValue

Gets the process data value from the specified path as a long value.

Syntax 

getProcessDataLongValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the long value in the process data model.

Returns

A long value coerced from the specified expression that represents a process data path.

getProcessDataDoubleValue

Gets the process data value from the specified path as a double value.

Syntax 

getProcessDataDoubleValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the double value in the process data model.

Returns

A double value coerced from the specified expression that represents a process data path.

getProcessDataFloatValue

Gets the process data value from the specified path as a float value.

Syntax 

getProcessDataFloatValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the float value in the process data model.

Returns

A float value coerced from the specified expression that represents a process data path.

getProcessDataStringValue

Gets the process data value from the specified path as a String value.

Syntax 

getProcessDataStringValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the string value in the process data model.

Returns

A string value coerced from the specified expression that represents a process data path.

getProcessDataDocumentValue

Gets the process data value from the specified path as a Document value.

You can also use the getProcessDataValue method to return an object and then determine if the object is of type com.adobe.idp.Document .

Syntax 

getProcessDataDocumentValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the string value in the process data model.

Returns

A document value coerced from the specified process data path expression. If no Document object is found, an empty Document object is returned.

getProcessDataListValue

Gets the process data list value from the specified path as a java.util.List value.

You can also use the getProcessDataValue method to return an object and then determine if the object is of type java.util.List .

Syntax 

getProcessDataListValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the list value in the process data model.

Returns

A java.util.List value coerced from the specified process data path expression. If no List object is found, an empty List object is returned.

getProcessDataMapValue

Gets the process data map value from the specified path as a java.util.Map value.

You can also use the getProcessDataValue method to return an object and then determine if the object is of type java.util.Map.

Syntax 

getProcessDataMapValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to the map value in the process data model.

Returns

A java.util.Map value coerced from the specified process data path expression. If no Map object is found, an empty Map object is returned.

getProcessDataValue

Gets the process data value from the specified path as an Object value.

Syntax 

getProcessDataValue(aPath)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a value in the process data model.

Returns

An object value coerced from the specified process data path expression.

setProcessDataBooleanValue

Sets a boolean value in the process data model.

Syntax 

setProcessDataBooleanValue( aPath, aVal)

Parameters

aPath is a string value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a boolean value of True or False .

setProcessDataShortValue

Sets a short value in the process data model.

Syntax 

setProcessDataShortValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a short value.

setProcessDataIntValue

Sets an int value in the process data model.

Syntax 

setProcessDataIntValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is an int value.

setProcessDataLongValue

Sets a long value in the process data model.

Syntax 

setProcessDataLongValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a long value.

setProcessDataDoubleValue

Sets a double value in the process data model.

Syntax 

setProcessDataDoubleValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a double value.

setProcessDataListValue

Sets a list value in the process data model.

Syntax 

setProcessDataListValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a list value.

appendToProcessDataListValue

Appends the items in a List value to a process variable of type list .

Syntax 

appendToProcessDataListValue(variableName, aVal)

Parameters

variableName is a java.lang.String that contains the name of the list variable to append to.

aVal is a List value. The items in aVal are appended to the list that variableName represents.

setProcessDataListValue

Set the value of an item at a given position in a list variable.

Syntax 

setProcessDataListValue(variableName, position, value)

Parameters

variableName is a java.lang.String that contains the name of the list variable.

position is an int value that contains the position in the list variable that is being set.

value is a java.lang.Object value to set in the list variable.

removeProcessDataListValue

Removes the object from a given position in a list variable.

Syntax 

removeProcessDataListValue(variableName, position)

Parameters

variableName is a java.lang.String value that contains the name of the list variable.

position is an int value that contains the position in the list variable that is being removed.

setProcessDataMapValue

Set a map value in the process data model.

Syntax 

setProcessDataMapValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a map value.

appendProcessDataMapValue

Appends the item in a Map object to a process variable of type map.

Syntax 

appendProcessDataMapValue(variableName, Map aVal)

Parameters

variableName is a java.lang.String value that contains the name of the map variable.

aVal is a Map value to append.

setProcessDataMapValue

Sets the value in a process data variable of type map for the specified key.

Syntax 

setProcessDataMapValue(variableName, key, value)

Parameters

variableName is a java.lang.String value that contains the name of the map variable.

key is a java.lang.String value that contains the key in the map that is being set.

value is a java.lang.Object value to set for the key in the map .

removeProcessDataMapValue

Removes the object for a given key value from the variable of type map .

Syntax 

removeProcessDataMapValue(variableName, key)

Parameters

variableName is a java.lang.String value that contains the name of the map variable.

key is a java.lang.String value that contains the key in the map for the value that is being removed.

setProcessDataFloatValue

Sets a float value in the process data model.

Syntax 

setProcessDataFloatValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a float value.

setProcessDataStringValue

Sets a String value in the process data model.

Syntax 

setProcessDataStringValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a String value.

setProcessDataDocumentValue

Sets a com.adobe.idp.Document object in the process data model.

Syntax 

setProcessDataDocumentValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is a com.adobe.idp.Document object.

setProcessDataValue

Sets an Object value in the process data model.

Syntax 

setProcessDataValue(aPath, aVal)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aVal is an Object value .

setProcessDataWithExpression

Sets the value of a location in the process data model using the value that an XPath expression evaluates to.

Syntax 

setProcessDataWithExpression(aPath, aExpression)

Parameters

aPath is a java.lang.String value that contains the XPath expression that evaluates to a location in the process data model in which to store the value.

aExpression is a java.lang.String value that represents the XPath expression.

getContainedDataTypeForCollection

Retrieves the data type that a list or map value contains.

Syntax 

getContainedDataTypeForCollection(variableName)

Parameters

variableName is a java.lang.String that represents the name of the list or map variable.

Returns

An int value that denotes the type of object:

0:
boolean

1:
short

2:
int

3:
long

4:
float

5:
double

6:
decimal

7:
string

8:
binary

9:
date

10:
date_time

11:
xml

13:
document

getProcessDataValueByVariableName

Returns the value for a process variable that can be referenced by name.

Syntax 

getProcessDataValueByVariableName(aVariableName)

Parameters

aVariableName is a java.lang.String value that represents the variable name.

Returns

An Object value that represents the value that the variable stores.

Throws

VariableNotFoundException exception if the named variable cannot be found.

// Ethnio survey code removed