Java API 仕様¶

ヒント

本ページでは、Java APIの仕様概要について説明しています。
詳細な仕様は、 Java API仕様書を参照ください。

パッケージ構成¶

Java APIは[jp.co.itarchitects.xFlow]以下のサブパッケージに、機能ごとに分類されています。

以下で各サブパッケージの概要について説明します。

パッケージ名	概要
action	申請／承認／差戻しを実行するためのインターフェースを提供します。また、申請／承認／差戻し確定をトリガーとして呼び出される、後処理抽象クラスも提供されています。後処理抽象クラスを実装したクラスを開発することで、各動作で任意の処理を実行させられます。
list	ワークフローシステムの一覧に関するインターフェースを提供します。特定のユーザーの処理待ちとなっている案件の一覧を取得できます。
define.bdf	ワークフローシステムで登録した申請フォームに関するインターフェースを提供します。主に、APIを使用して申請する際に利用されます。
define.user	組織／ユーザー情報に関するインターフェースを提供します。以下の4つの定義情報を参照、更新できます。 ①組織情報 ②ユーザー情報 ③グループ情報 ④役職情報
status	ワークフローシステムでこれまでに申請された案件情報に関するインターフェースを提供します。案件単位や、案件に関わるユーザー単位の情報を取得できます。
info	「管理者からのお知らせ」機能に関するインターフェースを提供します。管理機能で登録された「管理者からのお知らせ」情報を取得できます。
exception	APIがスローする例外を定義しています。

後処理プログラムの実行条件¶

後処理プログラムは、案件の状態や申請ルートの状況に応じて、実行されるクラスが異なります。

申請・承認など、処理種別によって実行される後処理プログラムの実行条件を以下に示します。

処理種別	実行対象
申請	FinalProcessAfterApply
承認	FinalProcessAfterApprove
閲覧	FinalProcessAfterBrowse
再申請請求	FinalProcessAfterAskToReapply
再承認請求	FinalProcessAfterAskToReapprove
否認	FinalProcessAfterDeny
下書き保存	FinalProcessAfterSave
取戻し	FinalProcessAfterCancel
承認取戻し	FinalProcessAfterCancelApprove

なお、承認により該当案件の状態が決裁済み、完了となる場合、上記に代わり、以下の後処理プログラムが実行されます。

状態	実行対象
決裁済み（※）	FinalProcessAfterSanction
完了	FinalProcessAfterCompletion

注釈

※ AND決裁グループの場合、最後の決裁者が承認した時以外は、承認の後処理プログラム（FinalProcessAfterApproveのサブクラス）が実行されます。

また、一度の申請・承認で複数の後処理プログラムが実行される場合があります。
例えば、決裁者までの申請ルート（閲覧者が存在しない）の場合、決裁者の承認により完了となるため、以下の決裁用、完了用後処理プログラムのサブクラスが続けて実行されます。

FinalProcessAfterSanction
FinalProcessAfterCompletion

また、スキップ承認により、申請者・承認者の処理によって案件の状態が決裁済みや、完了となった場合にも発生します。
閲覧者が存在せず、決裁者とその直前の承認者が同一ユーザーの申請ルートを例にします。
この申請ルートでは、承認者として承認した時点で決裁者はスキップされ、案件の状態は完了となります。
この場合は以下の承認用、決裁用、完了用後処理プログラムのサブクラスが続けて実行されます。

FinalProcessAfterApprove
FinalProcessAfterSanction
FinalProcessAfterCompletion

ただし、これはあくまで、申請・承認の結果スキップ承認が発生して案件の状態が決裁済みまたは完了になる場合のみです。
同一のユーザーが承認者として連続した申請ルートで発生するスキップ承認の場合は、承認用後処理プログラムは一度のみ実行されます。