ナビゲーションに戻る

ApprovalEventHandler クラス メソッド

ApprovalEventHandler クラスは、プロセス内の特定のポイントで要求されるアクションの実行に使用されます。たとえば、新しい従業員が承認された場合、必須のアクションは、そのユーザーをアクティブにすることです。このクラスの目的は、特定のステータスまたはアクションのチェックをコンポーネントから承認フレームワークに移動することです。このセクションでは、ApprovalEventHandler クラス メソッドについて説明します。

構文

ApprovalEventHandler()

説明

このメソッドは、ApprovalEventHandler クラスのコンストラクタです。この唯一の目的は、他のメソッドへのアクセスに使用できるオブジェクトを作成することです。

構文

OnProcessLaunch(&appInst)

説明

このメソッドは、新しい承認プロセスの開始処理が正常に行われると、この承認プロセス インスタンスを使用して呼び出されます。

パラメータ

パラメータ

説明

&appInst

EOAW_CORE:ENGINE:AppInst として指定します。

戻り値

なし。

method OnProcessLaunch

   /+ &appInst as EOAW_CORE:ENGINE:AppInst +/

   /+ Extends/implements EOAW_CORE:ApprovalEventHandler.OnProcessLaunch +/

   &appInst.thread.SetAppKeys(&vndrRecord);

   %This.updateProcessFlag(&PENDING);

end-method;

構文

OnStepActivate(&stepinst)

説明

このメソッドは、ステップ インスタンスがアクティブ化されるときに使用します。そのステップと関連付けられた承認者およびレビュー担当者は、ワークリスト エントリをまだ受け取っていない場合は受け取ります。アクティブ化されたステップ インスタンス自体は、引数として渡されます。

パラメータ

パラメータ

説明

&stepinst

アクティブ化されたステップ インスタンスを EOAW_CORE:ENGINE:StepInst として指定します。

戻り値

なし。

構文

OnStepHold(&userinst)

説明

このメソッドは、ユーザーがアクションを実行したときに、このステップを保留にするために使用します。保留とは、ユーザーが後でアクションを実行しようとしていることを意味します。

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

戻り値

なし。

構文

OnStepReassign(&userinst, &origApprover)

説明

このメソッドは、ステップが再割当てされたときのアクションを示すために使用します。

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

&origApprover

文字列として指定します。

戻り値

なし。

構文

OnStepComplete(&stepinst)

説明

このメソッドは、ステップが完了したときに実行するアクションを示すために使用します。

パラメータ

パラメータ

説明

&stepinst

アクティブなステップ インスタンスを EOAW_CORE:ENGINE:StepInst として指定します。

構文

OnStepPushback(&userinst)

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

構文

OnStepReactivate(&stepins)

説明

このメソッドは、ステップが再度アクティブにされるときに使用します。

パラメータ

パラメータ

説明

&stepinst

現在のステップ インスタンスを EOAW_CORE:ENGINE:StepInst として指定します。

構文

OnFinalHeaderDeny(&appinst As EOAW_CORE:ENGINE:AppInst);

説明

このメソッドは、最終却下時に使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

戻り値

なし。

構文

OnHeaderDeny(&userinst)

説明

このメソッドは、ヘッダーの却下時に使用します。

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

構文

OnHeaderApprove(&appinst)

説明

このメソッドは、ヘッダーが承認されるときに実行するアクションを示すために使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

構文

OnNoApprovalNecessary(&appinst)

説明

このメソッドは、承認が必要ないときに使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

構文

OnLineDeny(&userstep)

説明

このメソッドは、行が却下されるときに実行するアクションを示すために使用します。

パラメータ

パラメータ

説明

&userstep

ユーザーステップを EOAW_CORE:ENGINE:UserStepInst として指定します。

構文

OnLineApprove(&appinst, &thread)

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

&thread

EOAW_CORE:ENGINE:Thread として指定します。

構文

OnAllLinesProcessed(&appinst, &approved, &denied)

説明

このメソッドは、全ての行が処理されるときに使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

&approved

EOAW_CORE:ENGINE:Thread の配列を指定します。

&denied

EOAW_CORE:ENGINE:Thread の配列を指定します。

構文

OnTerminate(&appinst As EOAW_CORE:ENGINE:AppInst);

説明

このメソッドは、アプリケーション インスタンスが終了されるときに使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

構文

OnError(&stepinst)

説明

このメソッドは、ステップ内でエラーが発生したときに使用します。

パラメータ

パラメータ

説明

&stepinst

ステップ インスタンスを EOAW_CORE:ENGINE:StepInst として指定します。

構文

OnStepReview(&stepinst, &reviewers)

説明

このメソッドは、ステップ インスタンスがレビューされるときに実行するアクションを示すために使用します。

パラメータ

パラメータ

説明

&stepinst

ステップ インスタンスを EOAW_CORE:ENGINE:StepInst として指定します。

&reviewers

レビューアーの UserId を文字列の配列として指定します。

構文

OnTimeout(&userinst, &notify)

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

&notify

文字列として指定します。

構文

OnAdHocInsert(&stepinst, &approver)

説明

このメソッドは、新しいアドホック レビュー担当者が挿入されるときに使用します。

パラメータ

パラメータ

説明

&stepinst

EOAW_CORE:ENGINE:AdHocStepInst として指定します。

&approver

承認者の UserId を文字列の配列として指定します。

構文

OnAdHocDelete(&stepinst)

説明

このメソッドは、アドホック ステップが削除されるときに使用します。

パラメータ

パラメータ

説明

&stepinst

EOAW_CORE:ENGINE:AdHocStepInst として指定します。

構文

OnUserLocked(&userinst)

説明

このメソッドは、ユーザーがロック アウトされるときに実行するアクションを示すために使用します。ユーザーがロック アウトされた場合、管理者に通知される必要があります。この場合でもシステムによってそのユーザーに承認がルーティングされるため、これは警告として動作します。

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

構文

OnStepRequestInformation(&userinst)

説明

このメソッドは、情報を求めるリクエストがあるときに使用します。

パラメータ

パラメータ

説明

&userinst

EOAW_CORE:ENGINE:UserStepInst として指定します。

構文

OnRequestInformationAdded(&appinst As EOAW_CORE:ENGINE:AppInst, &level As number, &notifyList As array of string);

説明

このメソッドは、リクエスト情報が追加されたときに使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

&level

承認レベルを数値として指定します。

&notifyList

通知先の UserId を文字列の配列として指定します。

構文

ProcessNotifications(&appinst)

説明

このメソッドは、通知を処理するために使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

構文

OnLineTerminate(&appinst, &thread)

説明

このメソッドは、行が終了されるときに使用します。

パラメータ

パラメータ

説明

&appinst

アプリケーション インスタンスを EOAW_CORE:ENGINE:AppInst として指定します。

&thread

EOAW_CORE:ENGINE:Thread として指定します。