patExecContext リファレンス

このセクションでは、 patExecContext オブジェクトで使用できるメソッドについて説明します。

getProcessId

現在実行中のプロセスインスタンスの識別子を取得します。

構文 

getProcessId()

戻り値

プロセスの識別子が格納されている long 値です。

getBranchId

現在実行中のブランチインスタンスの識別子を取得します。

構文 

getBranchId()

戻り値

ブランチの識別子が格納されている long 値です。

getActionId

現在実行中の操作インスタンスの識別子を取得します。

構文 

getActionId()

戻り値

操作インスタンスの識別子が格納されている long 値です。

getExecuteTemplate

実行するアクションを取得して、実行テンプレートにキャストします。

構文 

public ExecuteTemplate getExecuteTemplate()

getActionTemplate

実行するアクションを取得します。

構文 

public ActionTemplate getActionTemplate()

関連項目

com.adobe.workflow.template.document.ActionTemplate[リンク?]

getProcessDataBooleanValue

指定されたパスからプロセスデータ値を boolean 値として取得します。

構文 

getProcessDataBooleanValue(aPath)

パラメータ

aPath はプロセスデータモデルの boolean 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す boolean 値です。

getProcessDataShortValue

指定されたパスからプロセスデータ値を short 値として取得します。

構文 

getProcessDataShortValue(aPath)

パラメータ

aPath はプロセスデータモデルの short 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す short 値です。

getProcessDataIntValue

指定されたパスからプロセスデータ値を int 値として取得します。

構文 

getProcessDataIntValue(aPath)

パラメータ

aPath はプロセスデータモデルの int 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す int 値です。

getProcessDataLongValue

指定されたパスからプロセスデータ値を long 値として取得します。

構文 

getProcessDataLongValue(aPath)

パラメータ

aPath はプロセスデータモデルの long 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す long 値です。

getProcessDataDoubleValue

指定されたパスからプロセスデータ値を double 値として取得します。

構文 

getProcessDataDoubleValue(aPath)

パラメータ

aPath はプロセスデータモデルの double 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す double 値です。

getProcessDataFloatValue

指定されたパスからプロセスデータ値を float 値として取得します。

構文 

getProcessDataFloatValue(aPath)

パラメータ

aPath はプロセスデータモデルの float 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す float 値です。

getProcessDataStringValue

指定されたパスからプロセスデータ値を string 値として取得します。

構文 

getProcessDataStringValue(aPath)

パラメータ

aPath はプロセスデータモデルの string 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定した式によって生成された、プロセスデータパスを表す string 値です。

getProcessDataDocumentValue

指定されたパスからプロセスデータ値を Document 値として取得します。

また、 getProcessDataValue メソッドを使用すると、オブジェクトを返してから、オブジェクトの種類が com.adobe.idp.Document であるかどうかを判別できます。

構文 

getProcessDataDocumentValue(aPath)

パラメータ

aPath はプロセスデータモデルの string 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定したプロセスデータパス式から生成された 文書 値です。 Document オブジェクトがない場合、空の Document オブジェクトが返されます。

getProcessDataListValue

指定されたパスからプロセスデータの list 値を java.util.List 値として取得します。

また、 getProcessDataValue メソッドを使用すると、オブジェクトを返してから、オブジェクトの種類が java.util.List であるかどうかを判別できます。

構文 

getProcessDataListValue(aPath)

パラメータ

aPath はプロセスデータモデルの list 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定したプロセスデータパス式から生成された java.util.List 値です。 List オブジェクトがない場合、空の List オブジェクトが返されます。

getProcessDataMapValue

指定されたパスからプロセスデータの map 値を java.util.Map 値として取得します。

また、 getProcessDataValue メソッドを使用すると、オブジェクトを返してから、オブジェクトの種類が java.util.Map であるかどうかを判別できます。

構文 

getProcessDataMapValue(aPath)

パラメータ

aPath はプロセスデータモデルの map 値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定されたプロセスデータパス式から生成された java.util.Map 値です。 Map オブジェクトがない場合、空の Map オブジェクトが返されます。

getProcessDataValue

指定されたパスからプロセスデータ値を Object 値として取得します。

構文 

getProcessDataValue(aPath)

パラメータ

aPath はプロセスデータモデルの値に評価する XPath 式が格納されている java.lang.String 値です。

戻り値

指定したプロセスデータパス式から生成された object 値です。

setProcessDataBooleanValue

プロセスデータモデルに boolean 値を設定します。

構文 

setProcessDataBooleanValue( aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている string 値です。

aVal は boolean 値で、 True と False のいずれかを設定します。

setProcessDataShortValue

プロセスデータモデルに short 値を設定します。

構文 

setProcessDataShortValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は short 値です。

setProcessDataIntValue

プロセスデータモデルに int 値を設定します。

構文 

setProcessDataIntValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は int 値です。

setProcessDataLongValue

プロセスデータモデルに long 値を設定します。

構文 

setProcessDataLongValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は long 値です。

setProcessDataDoubleValue

プロセスデータモデルに double 値を設定します。

構文 

setProcessDataDoubleValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は double 値です。

setProcessDataListValue

プロセスデータモデルに list 値を設定します。

構文 

setProcessDataListValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は list 値です。

appendToProcessDataListValue

List 値の項目を list 型のプロセス変数に追加します。

構文 

appendToProcessDataListValue(variableName, aVal)

パラメータ

variableName は追加する list 変数の名前が格納されている java.lang.String です。

aVal は List 値です。 aVal 内の各項目は variableName が表す list に追加されます。

setProcessDataListValue

list 変数の特定の位置にある項目の値を設定します。

構文 

setProcessDataListValue(variableName, position, value)

パラメータ

variableName は list 変数の名前が格納されている java.lang.String です。

position は設定する list 変数の位置が格納されている int 値です。

value は list 変数にセットする java.lang.Object 値です。

removeProcessDataListValue

list 変数の特定の位置からオブジェクトを削除します。

構文 

removeProcessDataListValue(variableName, position)

パラメータ

variableName は list 変数の名前が格納されている java.lang.String 値です。

position は削除する list 変数の位置が格納されている int 値です。

setProcessDataMapValue

プロセスデータモデルに map 値を設定します。

構文 

setProcessDataMapValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は map 値です。

appendProcessDataMapValue

Map オブジェクトの項目を map 型のプロセス変数に追加します。

構文 

appendProcessDataMapValue(variableName, Map aVal)

パラメータ

variableName は map 変数の名前が格納されている java.lang.String 値です。

aVal は追加する Map 値です。

setProcessDataMapValue

指定したキーに対する map 型のプロセスデータ変数に値を設定します。

構文 

setProcessDataMapValue(variableName, key, value)

パラメータ

variableName は map 変数の名前が格納されている java.lang.String 値です。

key は設定する map の key が格納されている java.lang.String 値です。

value は map の key に設定する java.lang.Object 値です。

removeProcessDataMapValue

map 型の変数から特定の key 値に対するオブジェクトを削除します。

構文 

removeProcessDataMapValue(variableName, key)

パラメータ

variableName は map 変数の名前が格納されている java.lang.String 値です。

key は削除する値のマップの key が格納されている java.lang.String 値です。

setProcessDataFloatValue

プロセスデータモデルに float 値を設定します。

構文 

setProcessDataFloatValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は float 値です。

setProcessDataStringValue

プロセスデータモデルに String 値を設定します。

構文 

setProcessDataStringValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は String 値です。

setProcessDataDocumentValue

プロセスデータモデルに com.adobe.idp.Document 値を設定します。

構文 

setProcessDataDocumentValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は com.adobe.idp.Document オブジェクト

setProcessDataValue

プロセスデータモデルに Object 値を設定します。

構文 

setProcessDataValue(aPath, aVal)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aVal は Object 値 です。

setProcessDataWithExpression

XPath 式が評価する値を使用してプロセスデータモデルに場所を示す値を設定します。

構文 

setProcessDataWithExpression(aPath, aExpression)

パラメータ

aPath は値を保存するプロセスデータモデル内の場所に評価する XPath 式が格納されている java.lang.String 値です。

aExpression は XPath 式を表す java.lang.String 値です。

getContainedDataTypeForCollection

list 値または map 値に格納されているデータタイプを取得します。

構文 

getContainedDataTypeForCollection(variableName)

パラメータ

variableName は list 変数または map 変数の名前を表す java.lang.String です。

戻り値

オブジェクトのタイプを示す int 値です。

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:
文書

getProcessDataValueByVariableName

名前で参照できるプロセス変数の値を返します。

構文 

getProcessDataValueByVariableName(aVariableName)

パラメータ

aVariableName は変数名を表す java.lang.String 値です。

戻り値

変数に格納されている値を表す Object 値です。

発信

VariableNotFoundException 例外（名前付きの変数が見つからない場合）