ドキュメント関数

このセクションでは、式で使用可能な document 値を操作する関数について説明します。

getDocLength

ドキュメントのファイルサイズを取得します。

構文

    getDocLength(com.adobe.idp.Document)

パラメータ

com.adobe.idp.Document はシリアライズされたドキュメントの参照です。

戻り値

バイト単位でのドキュメントのファイルサイズを格納する Long 。パラメーターがドキュメントに評価されない場合は、 0 を返します。

vardocument という変数は、作業項目フォームとして送信された後にシリアライズされた PDF ファイルを参照します。次の例では、バイト単位での参照されたドキュメントのサイズである 455343 を返します。

getDocLength(/process_data/@vardocument)

getDocAttribute

指定したドキュメント属性の値を取得します。

構文

    getDocAttribute(com.adobe.idp.Document, String)

パラメータ

com.adobe.idp.Document はシリアライズされたドキュメントの参照です。 String は取得するドキュメント属性の名前を保持する文字列です。使用可能な属性については、 添付ファイルとメモのドキュメント属性 を参照してください。

戻り値

String で指定された属性の値。属性によって、返される値のタイプが決まります。 com.adobe.idp.Document パラメーターが com.adobe.idp.Document 値に評価されない場合、空の文字列を返します。 String が有効な属性名を保持しない場合は null を返します。

varattachment という document 変数は、タスクに添付された PDF ファイルを参照します。次の例では、添付ファイルのアクセス権限を表す integer を返します。

getDocAttribute(/process_data/@varattachment,"wspermission")

setDocAttribute

ドキュメント属性の値を設定します。

構文

    setDocAttribute(com.adobe.idp.Document, String, String)

パラメータ

com.adobe.idp.Document はシリアライズされたドキュメントの参照です。最初の String パラメーターは設定するドキュメント属性の名前を保持する文字列です。2 番目の String パラメーターは、ドキュメント属性に設定する値を保持する文字列です。使用可能な属性については、 添付ファイルとメモのドキュメント属性 を参照してください。

戻り値

2 番目の String パラメーターで指定された値に設定された最初の String パラメーターで指定された属性を持つ入力 com.adobe.idp.Document 値への参照。

最初のパラメーターがドキュメントに評価されない場合、指定された値に設定された指定された属性を持つ空の com.adobe.idp.Document 値への参照を返します。

2 番目または 3 番目のパラメーターが String に評価されない場合、変更されていない com.adobe.idp.Document 値への参照を返します。

次の例では、 vardoc1 という document 変数が参照するドキュメントの説明を返します。

setDocAttribute(/process_data/@vardoc1,"wsdescription",  
"An example description.")

getDocContentType

ドキュメントのコンテンツタイプを取得します。コンテンツタイプは、Web で送信されるドキュメントの mime-type プロパティに類似したドキュメントのタイプを示します。たとえば、PDF ドキュメントのドキュメントタイプは application/pdf です。

ドキュメントがタスクに添付されていた場合、ドキュメントのドキュメントタイプは値を持たないか、 setDocContent 関数で設定された任意の値を持つことがあります。詳細については setDocContentType を参照してください。

構文

    getDocContentType(com.adobe.idp.Document)

パラメータ

com.adobe.idp.Document document 変数で参照されるシリアライズされたドキュメントです。

戻り値

コンテンツタイプを格納する String 。パラメーターがドキュメントに評価されない場合に、空の String を返します。

setDocContentType

ドキュメントのコンテンツタイプを設定します。コンテンツタイプは、Web で送信されるドキュメントの mime-type プロパティに類似したドキュメントのタイプを示します。たとえば、PDF ドキュメントのドキュメントタイプは application/pdf です。

構文

    setDocContentType(com.adobe.idp.Document, String)

パラメータ

com.adobe.idp.Document document 変数で参照されるシリアライズされたドキュメントです。

String は、ドキュメントに設定するコンテンツタイプを格納する文字列です。

戻り値

パラメーターとして使用された com.adobe.idp.Document 値のコピーへの参照。最初のパラメーターが com.adobe.idp.Document に評価されない場合、指定したコンテンツタイプの新しい空のドキュメントを返します。

getDocContentBase64

Base64 でエンコードされた文字列としてドキュメントの内容を取得します。

構文

    getDocContentBase64(aDocument)

パラメータ

aDocument はシリアライズされたドキュメント値です。XPath 式を使用して、ドキュメント値を参照できます。

戻り値

ドキュメントを表す文字列値。パラメーターがドキュメント値に評価されない場合、空の文字列が返されます。

テキストファイルは、 documentVar というドキュメント変数に格納されています。テキストファイルの内容は、単語 content です。次の式は、文字列値 Y29udGVudA== を返します。

getDocConententBase64(/process_data/@documentVar)

getDocFromBase64

Base64 でエンコードされた文字列をドキュメントに変換します。

構文

    getDocFromBase64(aString)

パラメータ

aString は Base64 でエンコードされたテキストを格納する文字列値です。XPath 式を使用して、文字列値を参照できます。

戻り値

ドキュメントを表すドキュメント値、および aString に格納されたデコードされたテキストであるドキュメントの内容。

stringVar という文字列変数は、Base64 でエンコードされたテキスト Y29udGVudA== を格納します。次の式は、テキスト content を格納するドキュメントを返します。

getDocFromBase64(/process_data/@stringVar)