BusinessDocumentInterface

このインターフェースは、処理中のビジネス文書を表します。これには、18 個のメソッドがあります。

メソッド

getDocumentUUID
 

メソッドの説明

この文書に関連付けられた固有 ID を取得します。

構文

public String getDocumentUUID()
 

パラメーター

なし

メソッド

getDocumentParentUUID
 

メソッドの説明

この文書の親に関連付けられた固有 ID を取得します。

構文

public String getDocumentParentUUID()
 

パラメーター

なし

メソッド

createFile
 

メソッドの説明

ビジネス文書以外の ファイルをファイル・システムに書き込む場合に使用する File オブジェクトを作成します。ビジネス文書名に基づいて名前を作成します。このメソッドは、例えば、添付ファイルの処理に使用されます。また、同期応答文書が Sender Result オブジェクトで設定される必要がある場合に、File オブジェクトの作成にも使用されます。

構文

public File createFile()
 

パラメーター

なし

メソッド

getDocument
 

メソッドの説明

WBI-C 作業ディレクトリーにあるビジネス文書のファイル参照を取得します。

構文

public File getDocument()
 

パラメーター

なし

メソッド

setDocument
 

メソッドの説明

文書を WBI-C 作業ディレクトリーに書き込みます。

構文

public void setDocument(File document)
 

パラメーター

document
ビジネス文書

メソッド

getOriginalFile
 

メソッドの説明

オリジナル・ファイルのロケーション、つまり、in_process ディレクトリー (WBI-C 作業ディレクトリー) に取り込まれたロケーションを取得します。

構文

public File getOriginalFile()
 

パラメーター

なし

メソッド

getDocumentState
 

メソッドの説明

文書の状況を取得します。

構文

public String getDocumentState()
 

パラメーター

なし

メソッド

setDocumentState
 

メソッドの説明

文書の状況を設定します。

構文

public String setDocumentState(String state)
 

パラメーター

state
設定する状況

メソッド

addEvents
 

メソッドの説明

この文書と関連付けるイベントを追加します。これらのイベントは、イベント・ビューアーおよび文書ビューアーで表示されます。

構文

public void addEvents(EventInfo[] events)
 

パラメーター

events
追加する EventInfo オブジェクトの配列

メソッド

getEvents
 

メソッドの説明

この文書と関連付けられた EventInfo オブジェクトの配列を取得します。

構文

public EventInfo[] getEvents()
 

パラメーター

なし

メソッド

clearEvents
 

メソッドの説明

これまでのイベント・セットをクリアします。BPE がビジネス・プロセスのすべてのイベントの処理を終了すると、このメソッドが呼び出され、同じイベントを再度処理することがないよう、すべてのイベントをクリアします。

構文

public void clearEvents()
 

パラメーター

なし

メソッド

getAttribute
 

メソッドの説明

指定された属性を取得します。パッケージの名前やバージョンなどの情報の取得に使用されます。使用可能な属性のリストについては、以下の DocumentConstant クラスを参照してください。

構文

public Object getAttribute(String attrName)
 

パラメーター

attrName
要求された属性の名前

メソッド

setAttribute
 

メソッドの説明

指定された属性をこの文書に設定します。使用可能な属性のリストについては、以下の DocumentConstant クラスを参照してください。

構文

public void setAttribute(String attrName, Object attrValue)
 

パラメーター

attrName
設定する属性の名前

attrValue
設定する値

メソッド

getTempObject
 

メソッドの説明

このフローに関連付けられた一時オブジェクトを取得します。

構文

public Object getTempObject(String objectName)
 

パラメーター

objectName
要求されたオブジェクトの名前

メソッド

setTempObject
 

メソッドの説明

このフローに関連付けられた一時オブジェクトを設定します。

構文

public void setTempObject(String objectName, Object objectValue)
 

パラメーター

objectName
設定するオブジェクトの名前

objectValue
設定する値

メソッド

getAttachments
 

メソッドの説明

この文書の添付ファイルのリストを取得します。

構文

public ListIterator getAttachments()
 

パラメーター

なし

メソッド

addAttachment
 

メソッドの説明

この文書に添付ファイルを追加します。

構文

public void addAttachment(AttachmentInterface attachment)
 

パラメーター

attachment
追加する添付ファイル

メソッド

getTransportHeaders
 

メソッドの説明

受信側によって設定されたトランスポート・ヘッダーを取得します。

構文

public ListIterator getTransportHeaders()
 

パラメーター

なし

Copyright IBM Corp. 1997, 2004