ヘッダーをスキップ

Oracle Workflow APIリファレンス
リリース2.6.3.5

部品番号: B15622-01
前へ 次へ       目次 索引 用語集
         前へ  次へ          目次  索引  用語集

AbortProcess

PL/SQL構文

procedure AbortProcess


    (itemtype in varchar2,
itemkey in varchar2,
process in varchar2 default '',
result in varchar2 default eng_force);

Java構文

public static boolean abortProcess


    (WFContext wCtx,
String itemType,
String itemKey,
String process,
String result)

説明

プロセスの実行を中止し、未完了の通知を取り消します。 プロセスのステータスは、result引数で指定した結果によってCOMPLETEとみなされます。 また、未完了の通知やサブプロセスは、result引数に関係なく、結果によって強制的にCOMPLETEのステータスが設定されます。

このAPIは、oracle.apps.wf.engine.abortイベントも呼び出します。 このイベントに対する事前定義済のサブスクリプションはOracle Workflowに組み込まれていませんが、イベント発生時にカスタムの処理を実行する場合は、このイベントに対する独自のサブスクリプションをオプションで定義できます。 『Oracle Workflow開発者ガイド』のワークフロー・エンジン・イベントに関する項、『Oracle Workflow開発者ガイド』のイベント・サブスクリプションの定義(スタンドアロンOracle Workflowの場合)に関する項、『Oracle Workflow開発者ガイド』のイベント・サブスクリプションの作成または更新(Oracle Applicationsの場合)に関する項を参照してください。

引数(入力)

wCtx ワークフローのコンテキスト情報。Javaメソッドの場合にのみ必須です。 「Oracle Workflowのコンテキスト」を参照してください。
itemtype 有効な項目タイプ。
itemkey アプリケーション・オブジェクトの主キーから生成される文字列。この文字列により、項目タイプの項目が一意に識別されます。項目タイプと項目キーにより、プロセスが識別されます。 「CreateProcess」を参照してください。
process その項目タイプの特定のサブプロセスを選択するためのオプションの引数。プロセス・アクティビティのラベル名を指定します。プロセス・アクティビティのラベル名で特定のサブプロセスを識別できない場合は、ラベル名の前に親プロセスの内部名を追加できます。 たとえば、<parent_process_internal_name>:<label_name>のように指定します。この引数がNULLの場合は、項目の最上位レベルのプロセスが中止します。この引数のデフォルト値はNULLです。
result 中止されたプロセスに割り当てるステータス。 resultは、プロセスの「結果タイプ」で定義された値の1つか、次の標準エンジンの値の1つである必要があります。
eng_exception
eng_timeout
eng_force
eng_mail
eng_null
この引数のデフォルトは「eng_force」です。

次のコードは、JavaプログラムでabortProcess()をコールする方法の例です。このコード例は、WFTest.javaプログラムからの引用です。


// abort process, should see status COMPLETE with result 
// code force
System.out.println("Abort Process ..." + iType + "/" +
iKey);
if (!WFEngineAPI.abortProcess(ctx, iType, iKey, pr, null))
{
System.out.println("Seemed to have problem aborting...");
WFEngineAPI.showError(ctx);
}


          前へ   次へ           目次   索引   用語集



Oracleロゴ
Copyright © 2003, 2004, Oracle. All rights reserved.