uCosminexus Service Coordinator Interactive Workflow AP開発ガイド

3020-3-M81-70

前書き

対象製品

P-2955-CJ34 uCosminexus Business Process Developer 03-10　（適用OS：Windows Server 2016，Windows Server 2019，Windows 10 x64）

P-2943-CG34 uCosminexus Service Coordinator Interactive Workflow 03-10　（適用OS：Windows Server 2016，Windows Server 2019）

P-2955-CG34 uCosminexus Service Coordinator Interactive Workflow 03-10　（適用OS：Windows Server 2016，Windows Server 2019，Windows 10 x64）

P-9W43-CG31 uCosminexus Service Coordinator Interactive Workflow 03-10　（適用OS：Red Hat(R) Enterprise Linux(R) Server 7.1（64-bit x86_64）以降，Red Hat(R) Enterprise Linux(R) Server 8.1（64-bit x86_64）以降）

これらのプログラムプロダクトのほかにもこのマニュアルをご利用になれる場合があります。詳細は「リリースノート」でご確認ください。

本製品では日立ネットワークオブジェクトプラザトレース共通ライブラリをインストールします。

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI，Cosminexus，HiRDB，uCosminexusおよびWorkCoordinatorは，株式会社 日立製作所の商標または登録商標です。

IBM，AIXは，世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Internet Explorerは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleおよびJavaは，オラクルおよびその関連会社の登録商標です。

Red Hat is a registered trademark of Red Hat, Inc. in the United States and other countries.

Red Hatは，米国およびその他の国におけるRed Hat, Inc.の登録商標です。

SQL Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

UNIXは，The Open Groupの商標です。

Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名，製品名などは，それぞれの会社の商標もしくは登録商標です。

発行

2021年8月　3020-3-M81-70

著作権

All Rights Reserved. Copyright (C) 2007, 2021, Hitachi, Ltd.

奥付

マニュアル発行元

株式会社 日立製作所

〒100‒8280　東京都千代田区丸の内一丁目6番6号

変更内容

変更内容(3020-3-M81-70)　uCosminexus Service Coordinator Interactive Workflow 03-10

追加・変更内容

変更個所

JDKのバージョンの記述を変更した。

2.2.2(1)

「注意事項」に，Javaアプリケーションを実行する際に必要なクラスパスについての参照マニュアルを追加した。

2.2.2(2)

CIWProcessInstanceインタフェースにstartAndAdhocInstantiateActivityInstanceByADNameメソッドを追加した。

5.5

単なる誤字・脱字などはお断りなく訂正しました。

OS，ブラウザ，およびデータベースに関して，新しいバージョンの追加，および古いバージョンの削除については記載していません。サポートしているバージョンの詳細については「リリースノート」でご確認ください。

はじめに

このマニュアルは，uCosminexus Service Coordinator Interactive Workflow上で動作するAPIの使用方法について説明したものです。

以降，このマニュアルでは，上記のプログラムプロダクトをCSCIWと称します。また，CSCIWを使用した業務システム全体の総称をワーク管理システムとします。

なお，BPMN連携機能を使用する場合にCSCIWで使用するAPIについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引」を参照してください。

対象読者

このマニュアルは，CSCIWを使用して対話型ワークフローを適用したシステムを開発される方を対象としています。また，次の知識をお持ちであることを前提にしています。

使用しているOSに関する基本的な知識

CosminexusおよびJavaEEに関する知識

リレーショナルデータベースの操作（SQL文など）に関する知識

読書手順

このマニュアルは，利用目的に合わせて章を選択して読むことができます。利用目的別に次の流れに従ってお読みいただくことをお勧めします。

図中で使用する記号

このマニュアルの図中で使用する記号を次のように定義します。

このマニュアルで使用する記号

このマニュアルで使用する記号を次のように定義します。

記号

意味

<　>

可変値を意味します。

コマンドの説明で使用する記号

コマンドの説明で使用する記号を次のように定義します。

記号

意味

<　>

可変値を意味します。

│（ストローク）

横に並べられた複数の項目に対し，項目間の区切りを示します。

{　}

この記号で囲まれている複数の項目のうちから1つを選択することを意味します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。

例

{A｜B}は，「Aと指定する」または「Bと指定する」ことを示します。

(　)

この記号で囲まれている複数の項目のうちから1つ以上を選択することを意味します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つ以上を選択します。

例

(A｜B)は，「Aと指定する」，「Bと指定する」または「AおよびBと指定する」ことを示します。

[　]

この記号で囲まれている項目は省略してよいことを意味します。

例

[A]は「何も指定しない」か「Aを指定する」ことを示します。

操作の説明で使用する記号

操作の説明で使用する記号を次のように定義します。

記号

意味

［　］

次のどれかを示します。

ボタン

キーボードのキー

画面またはダイアログの名称

画面またはダイアログに表示される項目

［A］+［B］

+の前のキーを押したまま，後ろのキーを押すことを示します。

［AAA］−［BBB］

−の前に示したメニューから，−の後ろのメニューを選択することを示します。

このマニュアルで使用する注記

このマニュアルで使用する注記を次に示します。

重要

操作を完了させるための重要な情報を示します。

メモ

本文に対して強調したい内容または補足事項を示します。

ヒント

操作する上で効果的な情報，指針，提案を示します。

適用OSの違いによる機能相違点の表記

このマニュアルで説明する機能は，適用OSの種類（UNIXまたはWindows）によって，異なる場合があります。OSによって機能差がある場合，OS名を明記しています。また，OSによってバージョン，リビジョンが異なる場合があります。バージョン，リビジョンによって操作方法などが異なる場合はそれぞれの説明にOS名，バージョン，およびリビジョンを明記しています。

なお，UNIXおよびWindowsの共通の説明部分に使用している「ディレクトリ」という用語は，Windows の場合は，特に断りのないかぎり，「フォルダ」と読み替えてください。また，UNIXのパスの区切り文字として使用している「/」は，Windowsの場合には，特に断りのないかぎり，「¥」に読み替えてください。

第1編　解説編

1　ビジネスプロセスの開発方法

この章では，CSCIWで使用するビジネスプロセスの開発方法について説明します。

1.1　CSCIWで使用するビジネスプロセス定義と振り分けルール定義の開発

CSCIWで使用するビジネスプロセス（ビジネスプロセス定義および振り分けルール定義）は，CSCIW-Definerを使用して開発します。

開発したビジネスプロセスをチェックし，エラーがないことを確認します。確認したあと，CSCIW-Definer，またはコマンドを使用して，ビジネスプロセスを登録します。

ビジネスプロセスの登録の流れを次の図に示します。

なお，図中の数字は，説明文の項番と対応しています。

図1‒1　ビジネスプロセスの登録の流れ（CSCIW-Definerを使用する場合）

説明

登録するビジネスプロセス定義または振り分けルール定義を指定します。

［登録］メニューを選択し，登録処理を実行します。

登録処理を実行すると，CSCIWManagementServerを経由して，開発したビジネスプロセス定義または振り分けルール定義の内容がワーク管理データベースに登録されます。

図1‒2　ビジネスプロセスの登録の流れ（コマンドを使用する場合）

説明

開発したビジネスプロセス定義および振り分けルール定義をローカルファイルに保存します。

ローカルファイルに保存したビジネスプロセス定義ファイルおよび振り分けルール定義ファイルをCSCIW実行マシンにファイル転送プロトコル（FTP）などで転送します。なお，FTPの転送モードは，バイナリモードで転送する必要があります。また，CSCIW実行マシンが複数ある場合は，任意の1台に転送してください。

転送されたビジネスプロセス定義ファイルおよび振り分けルール定義ファイルを指定し，ciwmngbp（ビジネスプロセス定義の管理）コマンドおよびciwmngcr（振り分けルール定義の管理）コマンドを実行します。

コマンドを実行すると，指定したビジネスプロセス定義ファイルおよび振り分けルール定義ファイルの内容がワーク管理データベースに登録されます。

注意事項

ビジネスプロセス定義および振り分けルール定義を追加，変更，または削除したあとは，すべてのJ2EEサーバにあるCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションを再起動してください。再起動することで，キャッシュしているビジネスプロセス定義および振り分けルール定義が反映されます。詳細は，マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」の「ビジネスプロセス定義および振り分けルール定義の変更」を参照してください。

参考事項

CSCIW-Definerについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド」を参照してください。

コマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow コマンド」を参照してください。

1.2　ビジネスプロセスの変更

業務システム運用中に，業務の流れを変更する場合は，ビジネスプロセス自体の変更が必要になります。ビジネスプロセスを変更する場合，登録済みの定義ファイルを取得し，定義を変更します。定義ファイルの内容を変更するときに，定義のバージョン番号を更新すると，すでに運用中の案件はそのままで，別の案件（同一名称でバージョンが異なる）として投入できます。定義のバージョン番号を更新しなければ，変更後の内容が案件に反映（上書き）されます。

重要

定義のバージョンを更新しないで上書きする場合，運用中のほかの案件に影響を与えるおそれがあるので，注意が必要です。また，変更できる範囲に制限があるため，ビジネスプロセス自体を変更する場合は，定義のバージョンを更新して登録することを推奨します。

ここでは，ビジネスプロセスを変更するときに，定義のバージョン番号を更新する場合と更新しない場合の手順を説明します。

1.2.1　ビジネスプロセスの変更（定義のバージョンを更新する場合）

ビジネスプロセスの変更時に定義のバージョンを更新する場合の手順について説明します。

(1)　定義ファイルの変更

登録済みのビジネスプロセスの変更は，CSCIW-Definer，またはコマンドで実行できます。CSCIW-Definerを使用し，定義ファイルを変更するときの流れを図1-3に，コマンドを使用し，定義ファイルを変更するときの流れを図1-4に示します。

なお，図中の数字は，説明文の項番と対応しています。

図1‒3　定義ファイルの変更の流れ（CSCIW-Definerを使用する場合）

説明

登録済みのビジネスプロセス定義または振り分けルール定義を開きます。

定義のバージョン番号を更新し，定義ファイルの内容を変更します。

バージョン番号は，更新前より大きな番号にしてください。

変更後のビジネスプロセスをチェックし，エラーがないことを確認します。確認したあと，CSCIW-Definerを使用してビジネスプロセスを登録します。

定義ファイルの登録の流れについては，「1.1　CSCIWで使用するビジネスプロセス定義と振り分けルール定義の開発」を参照してください。

図1‒4　定義ファイルの変更の流れ（コマンドを使用する場合）

説明

ciwmngbp（ビジネスプロセス定義の管理）コマンドまたはciwmngcr（振り分けルール定義の管理）コマンドを実行し，登録済みの定義ファイルを取得します。

取得した定義ファイルをファイル転送プロトコル（FTP）などでビジネスプロセス定義開発マシンに転送します。

転送した定義ファイルをCSCIW-Definerで開きます。

定義のバージョン番号を更新し，定義ファイルの内容を変更します。

バージョン番号は，更新前より大きな番号にしてください。

変更後の定義ファイルの内容をチェックし，エラーがないことを確認します。確認したあと，コマンドを使用してビジネスプロセスを登録します。

定義ファイルの登録の流れについては，「1.1　CSCIWで使用するビジネスプロセス定義と振り分けルール定義の開発」を参照してください。

参考事項

CSCIW-Definerについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド」を参照してください。

コマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow コマンド」を参照してください。

(2)　運用例

定義のバージョンを更新する場合の，バージョンの更新と案件の投入のタイミングについて次に示す図を例に説明します。

なお，図中の数字は，説明文の項番と対応しています。

図1‒5　定義のバージョンを更新する場合の運用例

説明

2007年4月1日に，業務プログラム（案件（バージョン番号の指定なし）の投入）が，ビジネスプロセスA（バージョン番号：1）を案件として投入します。

2007年10月1日に，ビジネスプロセスA（バージョン番号：1）に対して定義を変更し，案件投入可能期間を2007年10月22日以降に設定して，ビジネスプロセスA（バージョン：2）として登録します。

2007年10月21日以前にバージョン番号1として投入された案件は，そのままバージョン1で実行を続けます。

2007年10月22日以降に，業務プログラム（案件（バージョン指定なし）の投入）が，変更後のビジネスプロセスA（バージョン番号：2）を案件として投入します。

ビジネスプロセスA（バージョン番号：1）の案件がすべて完了し，完了した案件をすべて削除すると，ビジネスプロセスA（バージョン番号：1）を削除できます。

1.2.2　ビジネスプロセスの変更（バージョンを更新しない場合）

ビジネスプロセス定義のバージョン番号を更新しないで定義内容を変更するには，ciweditbp（ビジネスプロセス定義の変更）コマンドを使用します。

登録済みの定義ファイルの変更手順を次の図に示します。

なお，図中の数字は，説明文の項番と対応しています。

図1‒6　登録済みの定義ファイルの変更

説明

ciwmngbp（ビジネスプロセス定義の管理）コマンドを実行し，変更したいビジネスプロセス定義を取得します。

ciwmngbp（ビジネスプロセス定義の管理）コマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow コマンド」を参照してください。

取得したビジネスプロセス定義ファイルをファイル転送プロトコル（FTP）などでビジネスプロセス定義開発マシンに転送します。

転送したビジネスプロセス定義ファイルをCSCIW-Definerで開きます。

開いた定義ファイルのバージョン番号はそのままにし，定義だけを変更します。

メモ

CSCIW-Definerでビジネスプロセス定義を取得することもできます。

変更後のビジネスプロセス定義の登録手順を次の図に示します。

図1‒7　変更後のビジネスプロセス定義の登録

変更後のビジネスプロセス定義をローカルファイルに保存します。

ローカルファイルに保存したビジネスプロセス定義ファイルをCSCIW実行マシンにFTPなどで転送します。なお，FTPの転送モードはバイナリモードで転送する必要があります。また，CSCIW実行マシンが複数ある場合は，任意の1台に転送してください。

転送されたビジネスプロセス定義ファイルを指定し，ciweditbp（ビジネスプロセス定義の変更）コマンドを実行します。

コマンドを実行すると，転送されたビジネスプロセス定義ファイルのCSCIWに登録し，ワーク管理データベース上の指定されたビジネスプロセス定義の内容を変更します。

注意事項

ビジネスプロセス定義を変更したあとは，すべてのJ2EEサーバにあるCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションを再起動してください。再起動することで，キャッシュしているビジネスプロセス定義が反映されます。詳細は，マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」の「ワーク管理システムの運用」を参照してください。

参考事項

CSCIW-Definerについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド」を参照してください。

コマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow コマンド」を参照してください。

1.3　ビジネスプロセスを定義するときの注意事項

1.3.1　組み込み変数

(1)　指定できる組み込み変数

条件，振り分けルール，または生成ルールのSQL文で指定できる組み込み変数を次の表に示します。なお，指定された組み込み変数は，評価時に対応する値に置き換わります。

表1‒1　指定できる組み込み変数

組み込み変数

説明

条件

振り分けルール

生成

ルール

業務ステップ

作業

制御ノード

子作業

完了条件

発生条件

完了条件

分岐条件

@PIID

案件ID

○

○

○

○

○

○

@PIName

案件名

○

○

○

○

○

○

@AIName

業務ステップ名

○

○

○

−

○

○

@WIName

作業名

−

−

○

−

○

○

@PDefName

ビジネスプロセス定義名

○

○

○

○

○

○

@PDefVersion

ビジネスプロセス定義のバージョン

○

○

○

○

○

○

@ADefName

業務ステップ定義名

○

○

○

−

○

○

@WDefName

作業定義名

−

−

○

−

○

○

@CNDefName

制御ノード定義名

−

−

−

○

−

−

@PICreator

案件投入者

○

○

○

○

○

○

@PIStartDate

案件開始日時

○

○

○

○

○

○

@PIDeadline

案件処理期限

○

○

○

○

○

○

@PIPriority

案件優先度

○

○

○

○

○

○

@AIStartDate

業務ステップ開始日時

○

○

○

−

○

○

@AIDeadline

業務ステップ処理期限

○

○

○

−

○

○

@AIPriority

業務ステップ優先度

○

○

○

−

○

○

@WICreationDate

作業生成日時

−

−

○

−

○

○

@WIStartDate

作業開始日時

−

−

○

−

○

○

@WIDeadline

作業処理期限

−

−

○

−

○

○

@WIPriority

作業優先度

−

−

○

−

○

○

@WIParticipant

作業者

−

−

○

−

○

○

@UserID

ユーザ識別子

○

○

○

○

○

○

（凡例）

○：指定できます。

−：該当しません。

(2)　組み込み変数に関する注意事項

組み込み変数に関する注意事項を次に示します。

「@」で始まり，英数字以外の文字または文末までの英数字文字列は変数と見なされます。

SQL文中で「@」を使用する場合は，「¥@」と記述してください。

例

abc¥@hitachi.com

SQL文中で「¥」を使用する場合は，「¥¥」と記述してください。

例

D:¥¥work

組み込み変数の直後に英数字を使用する場合は，組み込み変数と文字列の間に「¥」を指定してください。

例：組み込み変数「@PIName」に文字列「XYZ」を連結する場合

@PIName¥XYZ

組み込み変数の直後に「@」で始まる文字列を使用する場合は，組み込み変数と文字列の間に「¥」を指定してください。

例：組み込み変数「@PIName」に文字列「@hitachi.com」を連結する場合

@PIName¥@hitachi.com

ただし，組み込み変数を続けて使用する場合は，「¥」の指定は不要です。

例：組み込み変数「@PIName」と「@PIID」を連結する場合

@PIName@PIID

組み込み変数の直後に記号を使用する場合は，そのまま指定できますが，「@」および「¥」を使用する場合は，組み込み変数直後の場合でも「¥」を指定してください。

例：組み込み変数「@PIName」に文字列「#abc」を連結する場合

@PIName#abc

例：文字列「C:¥work¥」に組み込み変数「@PIName」と文字列「¥data」を連結する場合

C:¥¥work¥¥@PIName¥¥data

名称系の組み込み変数（@PINameなど）を使用した場合，案件名などの文字列にそのまま置き換えられます。そのため，案件名などにSQL文の特殊文字として扱われる次の文字は含めないことを推奨します。

“%”（半角パーセント記号）

“_”（半角アンダーバー）

SQL文のLIKE述語のパターン文字列中に組み込み変数を設定したときに，値となる文字列の中に“%“または”_”が含まれていると，期待した検索結果が得られないおそれがあります。

対象となる属性の値がnullの場合は，空文字列に置き換わります。

数値として扱うとき，空文字列に置き換わるとSQL構文エラーとなるおそれがありますので，注意してください。

開始日時，生成日時，および処理期限は，1970/01/01 00:00:00 GMTを起点とした通算秒に置き換わります。

子作業生成ルールの作業生成日時，作業開始日時，作業処理期限，作業優先度，および作業者には，それぞれ生成ルールを定義した並列作業の作業生成日時，作業開始日時，作業処理期限，作業優先度，および作業者が渡されます。

1.3.2　巡回部分を含むビジネスプロセス定義

複数の業務ステップ間で案件遷移の整合性を保つために，巡回部分を含むビジネスプロセス定義を指定する場合は，注意が必要です。

正しい利用例と誤った利用例を次に示します。

(1)　正しい利用例

次のような利用例であれば，業務ステップの実行中に巡回によって再度業務ステップが生成されるようなことはありません。

図1‒8　正しい利用例（巡回部分に制御ノードを含まない例）

図1‒9　正しい利用例（巡回部分に一組の分業と待合だけを含む例）

(2)　誤った利用例

次のような利用例は，業務ステップの実行中に巡回によって同一業務ステップが生成されるおそれがあります。

一組の分業と先着から成る巡回部分を含むビジネスプロセス定義の例

一組の分業と先着から成る巡回部分を含むビジネスプロセス定義の誤った利用例を次に2つ示します。これらの場合は，分業ノードと先着2ノードの間の業務ステップが実行中にもかかわらず，再度同一業務ステップが生成されるおそれがあります。

図1‒10　誤った利用例（巡回部分に含まれる制御ノードに一組の分業と先着が含まれる例）（パターン1）

図1‒11　誤った利用例（巡回部分に含まれる制御ノードに一組の分業と先着が含まれる例）（パターン2）

閉じていない分業ノードを含む巡回部分を含むビジネスプロセス定義の例

閉じていない分業ノードを含む巡回部分を含むビジネスプロセス定義の誤った利用例を次に示します。この場合は，巡回するたびに同一の業務ステップ2が生成されます。

図1‒12　誤った利用例（巡回部分に閉じていない分業ノードが含まれている例）

(3)　正しく動作するための条件

正しく動作するかどうかの判断の指針となるパターンについて，次に条件と図を示します。正しく動作させるためには，最低限次に示すどちらかのパターンの検査項目を満たしている必要があります。

パターン1

次に示すすべての条件を満たしているパターンです。

巡回部分（巡回部分の開始点となる先着ノードと，巡回部分の終了点となる分岐ノードの対で挟まれる部分）が，先着ノードからの入力遷移と分岐ノードへの出力遷移だけを持っていること

巡回部分の終了点となる分岐ノードへの遷移時は，必ず，巡回部分内のすべての待合ノードが待合状態ではないこと

巡回部分の終了点となる分岐ノードへの遷移時は，必ず，巡回部分内のすべての業務ステップが実行中ではないこと

巡回部分内のすべての先着ノードには，後続停止指定がないこと

巡回部分の開始点となる先着ノードには，後続停止指定がないこと

図1‒13　正しく動作するための条件を満たした例（パターン1）

パターン2

巡回部分に，業務ステップ，または後続停止指定がない先着ノードしか存在しないパターンです。

図1‒14　正しく動作するための条件を満たした例（パターン2）

1.3.3　SQL文

(1)　条件，生成ルールおよび振り分けルールでのSQL文の評価規則

ビジネスプロセスに定義されたSQL文に従って，CSCIWがワーク管理データベースを検索するときのSQL文の評価規則を説明します。ここで示す規則に従って，ビジネスプロセス定義，または振り分けルール定義のSQL文を定義する必要があります。

表1‒2　SQL文の評価規則

定義種別

評価対象

評価規則

ビジネスプロセス定義

条件

真偽（TrueまたはFalse）の結果を反対にする指定をしているかどうかで，次のようになります。

指定をしていない場合

問い合わせ結果が存在するときは，真（True）とします。

問い合わせ結果が存在しないときは，偽（False）とします。

指定をしている場合

問い合わせ結果が存在するときは，偽（False）とします。

問い合わせ結果が存在しないときは，真（True）とします。

なお，COUNT(*)を指定すると常に真（True）と見なされるため，指定しないでください。

生成ルール

問い合わせ結果の先頭列のすべての行に格納された文字列を，子作業または子業務ステップの識別子とします。

振り分けルール定義

振り分けルール

問い合わせ結果の先頭行かつ先頭列に格納された文字列を作業者のIDとします。

(2)　SQL文記述の注意

SQL文を記述する際は，次の点に注意する。

CSCIW-Definerでは，SQL文の文法チェックはしないため，CSCIWで使用するワーク管理データベースのDBMS規則を意識してSQL文を記述してください。

「@」で始まる半角英数字の文字列を，すべて組み込み変数と見なします。組み込み変数に関する注意事項については，「1.3.1(2) 組み込み変数に関する注意事項」を参照してください。

2　業務プログラムの作成方法

この章では，業務プログラムの処理の流れ，Javaオブジェクトおよび業務プログラム作成時に必要な設定について説明します。また，CSCIWのAPIを利用するときの注意事項についても説明します。

2.1　APIの特長

CSCIWで使用するAPIの特長について次に示します。

業務プログラムで，ワーク管理データベースと業務データベースの同期処理ができる（DBコネクション共有管理機能）

CSCIWでは，ワーク管理データベースと業務データベースのコネクションを共有できます。データベースのコネクションを共有することで，ワーク管理データベースに対する更新処理と業務データベースに対する更新処理を同一トランザクションで実行できます。

処理の対象や流れが理解しやすく，効率良く業務プログラムが作成できる

Java言語のクラスおよびインタフェースを，処理する対象ごとに案件，業務ステップ，作業などの単位で提供しています。処理の対象ごとにクラスおよびインタフェースを提供することで，処理の流れが理解しやすくなり，効率的に業務プログラムを作成できるようになります。

ポータビリティの高い業務プログラムが作成できる

Java言語およびEJBの仕様に基づいたプログラミングをすることで，プログラミングコードを変更しなくても，異なるプラットフォームで動作する業務プログラムを作成できます。

ヒント

BPMN連携機能を使用する場合，業務アプリケーションの開発には，REST APIまたはBPMN連携ライブラリのJava APIを使用します。Java APIで開発する場合，このマニュアルで説明する更新系APIは使用しません（ただし，参照系APIは，このマニュアルで説明しているAPIを使用します）。

REST APIおよびBPMN連携ライブラリのJava APIについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引」を参照してください。

2.2　Java業務プログラムの作成

Java業務プログラムの作成手順について説明します。

2.2.1　パッケージのインポート

CSCIWが提供するすべてのJava APIは，パッケージ「jp.co.Hitachi.soft.csciw」に所属します。CSCIWが提供するJava APIを使用するには，次に示すパッケージのインポート文を，ソースコードに記述する必要があります。

import jp.co.Hitachi.soft.csciw.*;

また，Javaオブジェクト呼び出し機能は，パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属します。Javaオブジェクト呼び出し機能を使用する場合は，次に示すパッケージのインポート文を，ソースコードに記述する必要があります。

import jp.co.Hitachi.soft.csciw.callback.*;

2.2.2　業務プログラムのコンパイル

(1)　Javaコンパイラのオプション

CSCIWでは，JDK8.0の機能を使用しています。このため，業務プログラムは，JDK8.0以降の機能を利用したソースとしてコンパイルする必要があります。javacコマンドの-sourceオプションには1.8以降または8以降を指定してください。

(2)　クラスパス

業務プログラムをコンパイルする場合は，次に示すJARファイルをクラスパスに設定します。

CSCIWをインストールした環境の場合

＜Windowsのとき＞

<CSCIWインストールディレクトリ>¥lib¥csciw.jar
<CSCIWインストールディレクトリ>¥lib¥csciwcmn.jar

＜UNIXのとき＞

/opt/hitachi/CSCIW/lib/csciw.jar
/opt/hitachi/CSCIW/lib/csciwcmn.jar

uCosminexus Business Process Developerをインストールした環境の場合

<uCosminexus Business Process Developerインストールディレクトリ>¥lib¥csciw.jar
<uCosminexus Business Process Developerインストールディレクトリ>¥lib¥csciwcmn.jar

注意事項

各アプリケーションのearにcsciw.jarファイルおよびcsciwcmn.jarファイルを組み込まないでください。

Javaアプリケーションを実行する際に必要なクラスパスは，マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」の「Javaアプリケーションの設定」を参照してください。

2.3　業務プログラムの処理の流れ

業務プログラムの処理の流れについて説明します。

2.3.1　CSCIWの初期化

プロセス開始時に，一度だけCSCIWを初期化します。

CSCIWの初期化方法は，CSCIWをJavaアプリケーションで使用する場合と，J2EEサーバで使用する場合とで異なります。

(1)　Javaアプリケーションで使用する場合

CIWAdminクラスのinitializeCIWFactoryメソッドを使用して，CSCIWを初期化します。CSCIWを初期化する場合の業務プログラムのコーディング例を次に示します。なお，例中の「factory」はCIWFactoryオブジェクトを，「ds」はjavax.sql.DataSourceオブジェクトを示します。

例

try {
    // データソース取得処理
    …
    CIWAdmin.initializeCIWFactory(ds);
}
catch(CIWFatalException e) {
    // 例外処理を記述
}

(2)　J2EEサーバで使用する場合

J2EEサーバ上にCSCIWManagementServerを配備し，開始すれば，CSCIWが初期化されます。

2.3.2　CIWFactoryオブジェクトの取得

CIWFactoryオブジェクトは，CIWFactoryクラスのgetInstanceメソッドを使用して取得します。CIWFactoryオブジェクトを取得する場合の業務プログラムのコーディング例を次に示します。なお，例中の「factory」は，CIWFactoryオブジェクトを示します。

例

try {
    CIWFactory factory = CIWFactory.getInstance();
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}

2.3.3　CIWServerオブジェクトの生成

CIWServerオブジェクトは，CIWFactoryクラスのcreateCIWServerメソッドを使用して生成します。

CIWServerオブジェクトの生成方法は，CIWServerオブジェクトをコネクションと関連づけるか，またはデータソースと関連づけるかどうかによって異なります。

(1)　CIWConnectionCoordinatorを使用してコネクションと関連づける場合

CIWServerオブジェクトは，ユーザ記述子だけを指定したcreateCIWServerメソッドを使用して生成します。CIWServerオブジェクトを生成する場合の業務プログラムのコーディング例を次に示します。なお，例中の「factory」は，CIWFactoryオブジェクトを示します。

例

try {
    CIWServer server = factory.createCIWServer("User");
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}

(2)　データソースと関連づける場合

ユーザ記述子とデータソースを指定したcreateCIWServerメソッドを使用して，CIWServerオブジェクトを生成します。CIWServerオブジェクトを生成する場合の業務プログラムのコーディング例を次に示します。なお，例中の「factory」はCIWFactoryオブジェクトを，「ds」はjavax.sql.DataSourceオブジェクトを示します。

例

try {
    // データソース取得処理
    …
    CIWServer server = factory.createCIWServer(
        "User",
        ds);
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}

2.3.4　CIWServerオブジェクトに対するConnectionオブジェクトの関連づけ

CIWConnectionCoordinatorクラスのattachDatabaseConnectionメソッドを使用して，CIWServerオブジェクトにConnectionオブジェクトを関連づけます。CIWServerオブジェクトにConnectionオブジェクトを関連づける場合の業務プログラムのコーディング例を次に示します。なお，例中の「server」はCIWServerオブジェクトを，「connection」はjava.aql.Connectionオブジェクトを示します。

例

try {
    // コネクション取得および自動コミットのOFF
    …
    CIWConnectionCoordinator coordinator = server.getConnectionCoordinator();
    coordinator.attachDatabaseConnection(connection);
}
catch(CIWFatalException e) {
    // 例外処理を記述
}
…

2.3.5　CSCIWを利用した業務処理の実装

CSCIWを利用した業務処理の実装例を示します。

(1)　案件の投入

案件を投入する場合の業務プログラムのコーディング例を次に示します。なお，例中の「server」は，CIWServerオブジェクトを示します。

例

try {
    // 案件名「案件1」を指定して，ビジネスプロセス定義
    // 「ビジネスプロセス定義1」の案件を投入する。
    Map<CIWProcessInstance.AttributeName, Object> attributes
        = new HashMap<CIWProcessInstance.AttributeName, Object>();
    attributes.put(
        CIWProcessInstance.AttributeName.NAME,
        "案件1");

    CIWProcessInstance processInstance = server
        .createAndStartProcessInstance(
            attributes,
            "ビジネスプロセス定義1",
            null);
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}
…

(2)　作業一覧の取得

作業一覧を取得する場合の業務プログラムのコーディング例を次に示します。なお，例中の「server」は，CIWServerオブジェクトを示します。

例

try {
    // 作業者IDが「User001」かつ「実行開始可能」状態の作業を
    // 生成日時の降順に取得する。
    EnumSet<CIWWorkItem.AttributeName> attributeNames
        = EnumSet.allOf(CIWWorkItem.AttributeName.class);
    List<CIWWorkItem> wiList = server.getWorkItemsList(
        "Participant = 'User001' AND StateCode = '"
            + CIWWorkItem.State.READY.toStateCode() + "'",
        "CreationDate DESC",
        0,
        -1,
        attributeNames);
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}
…

(3)　作業の開始と終了

作業を開始および終了する場合の業務プログラムのコーディング例を次に示します。なお，例中の「wi」は，CIWWorkItemオブジェクトを示します。

例

try {
    // 作業を「実行開始可能」状態から「作業者実行」状態にして「実行済み」
    // 状態にする。
    // 既に「作業者実行」状態の作業の場合は，completeメソッドを使用する。
    wi.performAndComplete();
    …
}
catch(CIWTransientException e) {
    // 例外処理を記述
}
…

(4)　条件に一致する作業の作業者割り当てと着手をする場合の実装例

条件に一致する作業の作業者割り当てと着手をする場合の実装について説明します。

CIWServerクラスのallocateWorkItemExメソッドとCIWWorkItemクラスのfreeメソッドを利用します。クラス，およびメソッドの詳細については，次の個所を参照してください。

「5.6　CIWServer（ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェース）」

「5.8　CIWWorkItem（作業のインタフェース）」

次の条件を満たす実装例を示します。

作業者が「SharedWork」である

優先度が「1以上」である

「作業者実行可能」状態の作業に，作業者を割り当てて着手する

業務処理に成功した場合は，「実行済み」状態に遷移する

業務処理に失敗した場合は，作業を返却して振り分けルールを再評価する

例

// 条件に一致する作業に作業者を割り当てて着手する（作業者は"TargetWorker"，状態は"作業者実行"になる）
// フィルター条件「作業者が"SharedWork", 優先度が1以上」
// ソート条件「作業作成日が小さい(古い日時)順」
String newParticipant = "TargetWorker";
String filter =" Participant = 'SharedWork' AND Priority >= 1 ";
String sort =" CreationDate ASC ";
EnumSet<CIWWorkItem.AttributeName> attributeNames = EnumSet.allOf(CIWWorkItem.AttributeName.class);

CIWWorkItem wi = ciwServer.allocateWorkItemEx(
      newParticipant,
      filter,
      sort,
      attributeNames,
      20);

// トランザクションをコミットする
connection.commit();

/** 何らかの業務処理をする **/

// 処理の結果（boolean  result）で処理を分岐
if(result) {
           // 処理が成功したので，作業を実行済にする
           wi.changeState(CIWWorkItem.State.EXECUTED);
} else {
          // 処理が失敗したので，作業を返却して振り分けルールを再評価する
          wi.free();
}
connection.commit();

2.3.6　CIWServerオブジェクトに対するConnectionオブジェクトの関連づけの解除

CIWConnectionCoordinatorクラスのdetachDatabaseConnectionメソッドを使用して，CIWServerオブジェクトに対するConnectionオブジェクトの関連づけを解除します。CIWServerオブジェクトとConnectionオブジェクトの関連づけを解除する場合の業務プログラムのコーディング例を次に示します。なお，例中の「server」は，CIWServerオブジェクトを示します。

例

try {
    …
    CIWConnectionCoordinator coordinator = server.getConnectionCoordinator();
    coordinator.detachDatabaseConnection();

    // トランザクションの終了処理
    …
}
catch(CIWFatalException e) {
    // 例外処理を記述
}

2.3.7　CSCIWの終了

プロセス終了前に，一度だけCSCIWの終了処理をします。

CSCIWの終了処理の方法は，Javaアプリケーションで使用する場合と，J2EEサーバで使用する場合とで異なります。

(1)　Javaアプリケーションで使用する場合

CIWAdminクラスのfinalizeCIWFactoryメソッドを使用して，CSCIWを終了します。CSCIWを終了する場合の業務プログラムのコーディング例を次に示します。

例

…
CIWAdmin.finalizeCIWFactory();

(2)　J2EEサーバで使用する場合

J2EEサーバ上に配備したCSCIWManagementServerを停止すれば，CSCIWは終了します。

2.4　条件およびルールの評価

条件定義，生成ルール定義，または振り分けルール定義に指定できる種別を次の表に示します。

表2‒1　条件定義，生成ルール定義，または振り分けルール定義に指定できる種別

種別

表示名

説明

RDB検索

RDB検索

SQL文を実行し，RDB検索を実行します。

Javaオブジェクト呼び出し

Java

Javaオブジェクトを呼び出し，ユーザが定義したJavaオブジェクトに従って評価します。

SQL文で指定できる組み込み変数については，「1.3.1(1) 指定できる組み込み変数」を参照してください。また，SQL文の評価規則については，「1.3.3(1) 条件，生成ルールおよび振り分けルールでのSQL文の評価規則」を参照してください。

Javaオブジェクトの作成については「2.6　Javaオブジェクトの作成」を参照してください。また，Javaオブジェクトに渡される情報については，「2.6.4　業務プログラムに渡される情報」を参照してください。

2.5　Javaオブジェクト呼び出し利用時の設定

条件，振り分けルール，生成ルール，および作業アプリケーションで，CSCIWが提供するインタフェースを実装するJavaオブジェクトを呼び出すことができます。

ヒント

このマニュアルでは，条件，振り分けルール，生成ルール，および作業アプリケーションのJavaオブジェクト呼び出し機能について説明します。

アプリケーション呼び出しサービスのJavaオブジェクト呼び出し機能については，マニュアル「uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引」を参照してください。

Javaオブジェクトを呼び出す設定手順を次に示します。

ビジネスプロセス定義の作業アプリケーション定義，条件またはルールの定義に，JavaオブジェクトのJavaクラス名をパッケージを含む形で記載する。

CSCIWが提供するjarファイルおよび作成したJavaオブジェクトを設定する。

Javaオブジェクトの設定方法は条件によって異なります。

●Javaアプリケーションの場合

業務アプリケーション実行時のクラスパスにcsciw.jarおよびJavaオブジェクトを設定します。Javaアプリケーションの場合の構成を次の図に示します。

図2‒1　Javaアプリケーションの場合の構成

●JavaオブジェクトをJ2EEアプリケーションに組み込む場合

J2EEサーバのコンテナ拡張ライブラリにcsciwcmn.jarを設定し，業務アプリケーション（J2EEアプリケーション）にcsciwj2ee.jarおよびJavaオブジェクトをインポートします。JavaオブジェクトをJ2EEアプリケーションに組み込む場合の構成を次に示します。

図2‒2　JavaオブジェクトをJ2EEアプリケーションに組み込む場合の構成

●Javaオブジェクトをコンテナ拡張ライブラリに組み込む場合

J2EEサーバのコンテナ拡張ライブラリにcsciw.jarおよびJavaオブジェクトを設定します。Javaオブジェクトをコンテナ拡張ライブラリに組み込む場合の構成を次の図に示します。

図2‒3　Javaオブジェクトをコンテナ拡張ライブラリに組み込む場合の構成

CSCIWは，ビジネスプロセス定義に記載されたJavaクラス名で，Javaオブジェクト（作業アプリケーション，条件／ルール）を呼び出す。

CSCIWは，3.で呼び出したJavaオブジェクトの戻り値で，作業状態の変更，条件判定，子作業生成および作業者を決定する。

2.6　Javaオブジェクトの作成

Javaオブジェクト呼び出しを利用するには，CSCIWが提供するインタフェースを実装する必要があります。CSCIWが提供するインタフェースの詳細については，「9.　Javaオブジェクト呼び出し用のインタフェース」を参照してください。この節では，Javaオブジェクトの作成方法について説明します。

2.6.1　作成時の注意事項

Javaオブジェクト作成時の注意事項を次に示します。

CSCIWが提供するインタフェースを必ず実装してください。

CSCIWが提供するインタフェースの詳細については，「9.　Javaオブジェクト呼び出し用のインタフェース」を参照してください。

CSCIWが提供するインタフェースを実装したクラスでは，引数のあるコンストラクタやpublic以外のコンストラクタを実装しないでください。

Javaオブジェクトでは，CSCIWが提供するAPIを発行しないでください。

データベースへアクセスする場合は，CSCIWがJavaオブジェクトに渡すjava.sql.Connectionを利用してください。

Javaオブジェクトの処理で，CSCIWが渡すjava.sql.Connectionのコネクションを切断したり，トランザクションを終了したりしないでください。

Javaオブジェクト呼び出しでは，複数スレッドから同時に実行される場合があるため，クラス変数（スタティック変数）を使用しないでください。

Javaオブジェクトのパッケージは，「jp.co.Hitachi.soft.csciw」以外にしてください。

Javaオブジェクトはリクエスト（作業アプリケーションやルール評価のタイミング）ごとにインスタンス化されます。そのため，インスタンス変数（メンバ変数）とメソッドローカル変数だけを利用したコーディングを推奨します。

2.6.2　Javaオブジェクトの実装例（条件，生成ルール，および振り分けルール）

条件定義，生成ルール定義，および振り分けルール定義の実装について説明します。条件またはルールの評価に渡される情報については，「2.6.4(1) Javaオブジェクトに渡される情報（条件，生成ルールおよび振り分けルールの場合）」を参照してください。

(1)　条件評価

条件評価の実装例を示します。

条件Javaオブジェクトのインタフェースについては，「9.2　CIWConditionEvaluator（条件Javaオブジェクトのインタフェース）」を参照してください。

例

public class UserCondition implements CIWConditionEvaluator {

    /**
     * 条件評価メソッドの実装
     */
    public boolean evaluateCondition(
        Map<Parameter, String> aParameters,
        Connection aDBConnection)
        throws CIWUserException {

        // ---------------------------------------------------
        // （１）情報の取得
        // ---------------------------------------------------

        String bpDefName = null; // ビジネスプロセス定義名
        String piName = null; // 案件名
        String piID = null; // 案件ID
        String exParameter = null; // 補助定数パラメタ
        String userId = null; // ユーザID

        bpDefName = aParameters.get(Parameter.CSCIW_PDEFNAME);
        piName = aParameters.get(Parameter.CSCIW_PINAME);
        piID = aParameters.get(Parameter.CSCIW_PIID);
        exParameter = aParameters.get(Parameter.CSCIW_EXPARAMETER);
        userId = aParameters.get(Parameter.CSCIW_USERID);

        // ---------------------------------------------------
        // （２）条件評価処理
        // ---------------------------------------------------

        boolean result = false;
        // データベースにアクセスする場合は，コネクション（aDBConnection）を利用する。
        // ただし，コネクションを切断したりトランザクションを終了したりしないこと。
        result = true; // 評価結果を格納

        // ---------------------------------------------------
        // （３）評価結果を戻り値に設定
        // ---------------------------------------------------

        return result;
    }
}

(2)　生成ルール評価

生成ルール評価の実装例を示します。

生成ルールJavaオブジェクトのインタフェースについては，「9.3　CIWCreationRuleEvaluator（生成ルールJavaオブジェクトのインタフェース）」を参照してください。

例

public class UserCreationRule implements CIWCreationRuleEvaluator {

    /**
     * 子作業生成ルール評価メソッドの実装
     */
    public Set<String> evaluateCreationRule(
        Map<Parameter, String> aParameters,
        Connection aDBConnection)
        throws CIWUserException {

        // ---------------------------------------------------
        // （１）情報の取得
        // ---------------------------------------------------

        String bpDefName = null; // ビジネスプロセス定義名
        String piName = null; // 案件名
        String piID = null; // 案件ID
        String exParameter = null; // 補助定数パラメタ
        String userId = null; // ユーザID

        bpDefName = aParameters.get(Parameter.CSCIW_PDEFNAME);
        piName = aParameters.get(Parameter.CSCIW_PINAME);
        piID = aParameters.get(Parameter.CSCIW_PIID);
        exParameter = aParameters.get(Parameter.CSCIW_EXPARAMETER);
        userId = aParameters.get(Parameter.CSCIW_USERID);

        // ---------------------------------------------------
        // （２）子作業名の決定処理
        // ---------------------------------------------------

        Set<String> childWorks = new HashSet<String>();
        // データベースにアクセスする場合は，コネクション（aDBConnection）を利用する。
        // ただし，コネクションを切断したりトランザクションを終了したりしないこと。
        childWorks.add("SubWork01"); // 子作業名の文字列を格納
        childWorks.add("SubWork02"); // 子作業名の文字列を格納

        // ---------------------------------------------------
        // （３）作業名を戻り値に設定
        // ---------------------------------------------------

        return childWorks;
    }
}

(3)　振り分けルール評価

振り分けルール評価の実装例を次に示します。

振り分けルールJavaオブジェクトのインタフェースについては，「9.4　CIWResourceSelector（振り分けルールJavaオブジェクトのインタフェース）」を参照してください。

例

public class UserResourceSelector implements CIWResourceSelector {

    /**
     * 振り分けルール評価メソッドの実装
     */
    public String getAvailableParticipant(
        Map<Parameter, String> aParameters,
        Connection aDBConnection)
        throws CIWUserException {

        // ---------------------------------------------------
        // （１）情報の取得
        // ---------------------------------------------------

        String bpDefName = null; // ビジネスプロセス定義名
        String piName = null; // 案件名
        String piID = null; // 案件ID
        String exParameter = null; // 補助定数パラメタ
        String userId = null; // ユーザID

        bpDefName = aParameters.get(Parameter.CSCIW_PDEFNAME);
        piName = aParameters.get(Parameter.CSCIW_PINAME);
        piID = aParameters.get(Parameter.CSCIW_PIID);
        exParameter = aParameters.get(Parameter.CSCIW_EXPARAMETER);
        userId = aParameters.get(Parameter.CSCIW_USERID);

        // ---------------------------------------------------
        // （２）作業者の決定処理
        // ---------------------------------------------------

        String workerName = null;
        // データベースにアクセスする場合は，コネクション（aDBConnection）を利用する。
        // ただし，コネクションを切断したりトランザクションを終了したりしないこと。
        workerName = "User01"; // 作業者のIDを文字列に格納する。

        // ---------------------------------------------------
        // （３）作業者を戻り値に設定
        // ---------------------------------------------------

        return workerName;
    }
}

2.6.3　Javaオブジェクトの実装例（作業アプリケーション）

作業アプリケーションの実装について説明します。Java呼び出し時に渡される情報については，「2.6.4(2) Javaオブジェクトに渡される情報（作業アプリケーションの場合）」を参照してください。

作業アプリケーションの実装例を次に示します。

例

public class UserWorkApplication implements CIWWorkApplication {

    /**
     * 作業アプリケーションの業務処理の実装
     */
    public Result startSynchronously(
        Map<Parameter, String> aParameters,
        Connection aDBConnection)
        throws CIWUserException {

        // ---------------------------------------------------
        // （１）情報の取得
        // ---------------------------------------------------

        String piName = null; // 案件名
        String piID = null; // 案件ID
        String wiID = null; // 作業ID
        String sid = null; // システムID
        String exParameter = null; // 補助定数パラメタ
        String userId = null; // ユーザID

        piName = aParameters.get(Parameter.CSCIW_PINAME);
        piID = aParameters.get(Parameter.CSCIW_PIID);
        wiID = aParameters.get(Parameter.CSCIW_WIID);
        sid = aParameters.get(Parameter.CSCIW_SYSTEMID);
        exParameter = aParameters.get(Parameter.CSCIW_EXPARAMETER);
        userId = aParameters.get(Parameter.CSCIW_USERID);

        // ---------------------------------------------------
        // （２）業務処理
        // ---------------------------------------------------

        Result appResult = null;
        // データベースにアクセスする場合は，コネクション（aDBConnection）を利用する。
        // ただし，コネクションを切断したりトランザクションを終了したりしないこと。
        appResult = Result.PERFORM_AND_COMPLETE; // 作業アプリケーションの完了コードを設定する。

        // ---------------------------------------------------
        // （３）作業アプリケーションの業務処理結果を戻り値に設定
        // ---------------------------------------------------

        return appResult;
    }
}

2.6.4　業務プログラムに渡される情報

この項では，業務プログラムに渡される情報について説明します。

(1)　Javaオブジェクトに渡される情報（条件，生成ルールおよび振り分けルールの場合）

CSCIWから条件，生成ルール，振り分けルールを呼び出す際に，条件，生成ルール，振り分けルールのJavaオブジェクトに渡される情報を次の表に示します。

表2‒2　条件またはルールの評価に渡される情報

パラメタ

説明

条件

振り分けルール

生成

ルール

業務ステップ

作業

制御ノード

子作業

完了条件

発生条件

完了条件

分岐条件

CSCIWPIID

案件ID

○

○

○

○

○

○

CSCIWPIName

案件名

○

○

○

○

○

○

CSCIWAIName

業務ステップ名

○

○

○

−

○

○

CSCIWWIName

作業名

−

−

○

−

○

○

CSCIWPDefName

ビジネスプロセス定義名

○

○

○

○

○

○

CSCIWPDefVersion

ビジネスプロセス定義のバージョン

○

○

○

○

○

○

CSCIWADefName

業務ステップ定義名

○

○

○

−

○

○

CSCIWWDefName

作業定義名

−

−

○

−

○

○

CSCIWCNDefName

制御ノード定義名

−

−

−

○

−

−

CSCIWExParameter

補助定数パラメタ

○

○

○

○

○

○

CSCIWPICreator

案件投入者

○

○

○

○

○

○

CSCIWPIStartDate

案件開始日時

○

○

○

○

○

○

CSCIWPIDeadline

案件処理期限

○

○

○

○

○

○

CSCIWPIPriority

案件優先度

○

○

○

○

○

○

CSCIWAIStartDate

業務ステップ開始日時

○

○

○

−

○

○

CSCIWAIDeadline

業務ステップ処理期限

○

○

○

−

○

○

CSCIWAIPriority

業務ステップ優先度

○

○

○

−

○

○

CSCIWWICreationDate

作業生成日時

−

−

○

−

○

○

CSCIWWIStartDate

作業開始日時

−

−

○

−

○

○

CSCIWWIDeadline

作業処理期限

−

−

○

−

○

○

CSCIWWIPriority

作業優先度

−

−

○

−

○

○

CSCIWWIParticipant

作業者

−

−

○

−

○

○

CSCIWUserID

ユーザ識別子

○

○

○

○

○

○

（凡例）

○：Javaオブジェクトに渡されます。

−：Javaオブジェクトに渡されません。

(2)　Javaオブジェクトに渡される情報（作業アプリケーションの場合）

CSCIWから作業アプリケーションを呼び出す際に，作業アプリケーションに渡される情報を次の表に示します。

表2‒3　作業アプリケーションに渡される情報

パラメタ

説明

CSCIWPIID

案件ID

CSCIWWIID

作業ID

CSCIWPIName

案件名

CSCIWAIName

業務ステップ名

CSCIWWIName

作業名

CSCIWSystemID

システムID

CSCIWPDefName

ビジネスプロセス定義名

CSCIWPDefVersion

ビジネスプロセス定義バージョン

CSCIWADefName

業務ステップ定義名

CSCIWWDefName

作業定義名

CSCIWExParameter

補助定数パラメタ

CSCIWPICreator

案件投入者

CSCIWPIStartDate

案件開始日時

CSCIWPIDeadline

案件処理期限

CSCIWPIPriority

案件優先度

CSCIWAIStartDate

業務ステップ開始日時

CSCIWAIDeadline

業務ステップ処理期限

CSCIWAIPriority

業務ステップ優先度

CSCIWWICreationDate

作業生成日時

CSCIWWIStartDate

作業開始日時

CSCIWWIDeadline

作業処理期限

CSCIWWIPriority

作業優先度

CSCIWWIParticipant

作業者

CSCIWUserID

ユーザ識別子

(3)　注意事項

Javaオブジェクトに渡される情報およびパラメタに関する注意事項を次に示します。

パラメタ名は列挙型Parameterで提供されます。

CSCIWからJavaオブジェクトに渡されるパラメタは，メソッド引数のMap aParameter経由で渡されます。Mapのキーは列挙型Parameterになります。

案件IDを取得する場合は，aParameter.get(Parameter.CSCIW_PIID)で取得します。

値はすべて文字列で渡されます。

値が未設定の場合は，nullが渡されます。

Javaオブジェクトに渡されない項目はキーが存在しない状態になります。存在しないキーを指定した場合は，nullが渡されます。

日時情報（開始日，生成日，および処理期限）を取得すると，1970/01/01 00:00:00 GMTを起点とした通算秒の文字列が渡されます。

補助定数パラメタを取得した場合は，ビジネスプロセス定義で指定された文字列が，空白を含めてそのまま文字列で渡されます。

子作業生成ルールの作業生成日時，作業開始日時，作業処理期限，作業優先度，および作業者には，それぞれ生成ルールを定義した並列作業の作業生成日時，作業開始日時，作業処理期限，作業優先度，および作業者が渡されます。

2.6.5　作業アプリケーションを作成するときの注意事項

作業アプリケーションを作成するときの注意事項について説明します。

作業の返却，および再開を行った場合，作業アプリケーションは同じ情報で呼び出されます。このため，作業アプリケーションは，複数回呼び出されても正しく一度だけ業務処理を行うように作成する必要があります。作業アプリケーションに渡される情報については，「2.6.4(2) Javaオブジェクトに渡される情報（作業アプリケーションの場合）」を参照してください。

作業アプリケーションの同期呼び出しで，エラーが発生し，ロールバックされたあとに再度呼び出す場合，作業IDは異なる値になることを考慮して作成する必要があります。

作業アプリケーションの着手（perform），および完了（performAndComplete）は，必ずメソッドの戻り値で指定してください。

2.7　一覧情報の取得

CSCIWのAPIで情報を取得する方法について説明します。

2.7.1　一覧情報の取得手順と基本動作

一覧情報の取得手順と基本動作について説明します。

(1)　一覧情報の取得手順

getXXXsListメソッドで一覧情報を取得する手順について説明します。

なお，getXXXsListメソッドの「XXX」の部分は，取得する一覧情報にあわせて次の中から該当する文字列に置き換えてください。

ActivityInstance（業務ステップオブジェクトの一覧情報を取得する場合）

ProcessDefinition（ビジネスプロセス定義オブジェクトの一覧情報を取得する場合）

ProcessInstance（案件オブジェクトの一覧情報を取得する場合）

WorkDefinition（作業定義オブジェクトの一覧情報を取得する場合）

WorkItem（作業オブジェクトの一覧情報を取得する場合）

図2‒4　getXXXsListメソッドで一覧情報を取得する手順

説明

フィルター条件，ソート条件，取得件数，オフセットなどを指定してgetXXXsListメソッドで検索結果を取得します。

getXXXsListメソッドは一度で複数の件数を取得できますが，一度の取得単位を少なくし，getXXXsListメソッドを繰り返すことで，少しずつ順に検索結果を取得することもできます。

ただし，メソッドを繰り返す間，検索の集合が固定されないため，タイミングによっては，続きのオフセットを指定しても，案件情報の重複や漏れが発生します。

なお，getXXXsListメソッドは，実際には一覧取得する情報の種類によって，それぞれ個別のメソッドを利用します。

(2)　一覧情報取得時のCSCIW内での動作

getXXXsListメソッドで一覧情報を取得する場合のCSCIW内での動作について説明します。

図2‒5　getXXXsListメソッドで一覧情報を取得する場合のCSCIW内での動作

説明

指定されたフィルター条件を満たす情報を指定されたソート順で返し，そのあと，検索結果領域を解放します。

getXXXsListメソッドでは，取得する件数の上限とオフセットを指定できます。この場合は，取得情報として検索結果の上位から指定されたオフセット分を除いて，指定された上限件数分だけ情報を返します。例えば，検索結果の101番目から50件の情報を取得する場合は，オフセットに100を指定し，上限に50を指定します。ソートを指定した場合は，全検索結果をソートしたあと，上位から指定されたオフセット分を除いて，指定された上限件数分だけ情報を返します（実際のソートはデータベースの機能で実行します）。取得件数の上限を指定すると，CSCIW内のリソース消費量を削減できます。

注意事項

取得する全情報数が多くなるとリソース不足が発生するおそれがあるので，取得する全情報数に注意して使用してください。

取得する全情報数とは，取得する最大情報数の指定（aMaxCount）とは無関係です。常にフィルター条件に合致する全情報数のことです。

(3)　一覧情報取得時の最大取得件数の指定

一覧取得する情報数については，取得する情報の最大取得件数をgetXXXsListメソッドで指定できます。

最大取得件数を指定する場合，getXXXsListメソッドの呼び出しで取得する情報の最大件数を，引数（aMaxCount）で指定します。この場合は，フィルター条件を満たす情報のうち，指定された最大件数分だけ検索結果を取得します。このため，フィルター条件を満たす情報数が引数（aMaxCount）で指定した数より多い場合でも，getXXXsListメソッドで取得できる情報数の上限は引数（aMaxCount）で指定した最大件数までとなります。getXXXsListメソッドで取得できる情報数の上限を超える情報を取得しようとした場合は，全情報を取得する指定（aMaxCountの値が-1）でこれ以上情報が存在しないときに，さらに情報を取得しようとしたときと同じ動作（長さ0の属性値リストを返す）をします。

なお，引数（aMaxCount）を0にすると，長さ0の属性値リストが返されます。

2.7.2　一覧情報取得時のフィルター条件

一覧情報取得時には情報を絞り込むためのフィルター条件を設定できます。フィルター条件は，SQLのWHERE句の形式で指定します。実際には，一覧情報を取得できるAPIで発行するSQLのWHERE句のあとに指定したフィルター条件が付加されます。

(1)　指定方法

フィルター条件指定の構文は，使用するDBMSのSQL構文に従います。

(a)　指定できる属性

フィルター条件として指定できる属性については，「付録B　参照系APIで指定できる属性」を参照してください。

なお，属性を指定する場合の注意事項を次に示します。

属性名は文字列で指定してください。

指定する属性名は，「"」（半角ダブルクォーテーション）で囲まないでください。

(b)　属性値の指定方法

日付データを条件に指定する場合

CIWUtilクラスのconvertDateToStringメソッドを使用します。このメソッドは，Dateオブジェクトから，フィルター条件で使用できる日付情報の値に変換した文字列を返すメソッドで，返された文字列を連結してフィルター条件を生成します。

例

SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
Date date = format.parse("2006/08/01 00:00:00");

String filterCondition = "StartDate < " + CIWUtil.convertDateToString(date);

状態を条件に指定する場合

フィルター条件で状態の値を使用する場合，各クラスに定義された列挙型StateのtoStateCodeメソッドを使用します。

例

String filterCondition = "StateCode = '" + CIWWorkItem.State.READY.toStateCode() + "'";

種類を条件に指定する場合

フィルター条件で種類の値を使用する場合，各クラスに定義された列挙型TypeのtoTypeCodeメソッドを使用します。

例

String filterCondition = "WorkTypeCode = '" + CIWWorkItem.Type.NORMAL.toTypeCode() + "'";

(2)　注意事項

フィルター条件の長さはDBMSの制限にだけ依存します。したがって，フィルター条件の長さはCSCIWではチェックしません。

フィルター条件の文字列はCSCIWでは内容をチェックしないで，SQLのWHERE句をそのまま構成する文字列として使用します。そのため，空文字を指定するとSQL例外になることがあります。フィルター条件を省略する場合は，nullを指定してください。

2.7.3　一覧情報取得時のソート条件

一覧情報取得時には，ソート条件を設定できます。ソート条件は，SQLのORDER BY句の形式で指定します。実際には，一覧情報を取得できるAPIで発行するSQLのORDER BY句のあとに指定したソート条件が付加されます。

(1)　指定方法

ソート条件指定の構文は，使用するDBMSのSQL構文に従います。

(a)　指定できる属性

ソート条件として指定できる属性については，「付録B　参照系APIで指定できる属性」を参照してください。

なお，属性を指定する場合の注意事項を次に示します。

属性名は文字列で指定してください。

指定する属性名は，「"」（半角ダブルクォーテーション）で囲まないでください。

(2)　注意事項

ソート条件の長さはDBMSの制限にだけ依存します。したがって，ソート条件の長さはCSCIWではチェックしません。

ソート条件の文字列はCSCIWでは内容をチェックしないで，SQLのORDER BY句をそのまま構成する文字列として使用します。そのため，空文字を指定するとSQL例外になることがあります。ソート条件を省略する場合は，nullを指定してください。

2.8　指定できるデータ

CSCIWのAPIで扱うデータについて説明します。

2.8.1　オブジェクトの取得で指定できる値

オブジェクトを取得する場合に，指定できる値を次に示します。

ID

IDはすべてjava.lang.Integer型で定義されています。指定できる値は，java.lang.Integer型の範囲に従います。

なお，nullは指定できません。

取得する属性のセット

取得する属性のセットは，java.util.Set型で定義されています。オブジェクトごとのAttributeName列挙型の定数を要素に持っています。

なお，nullを指定した場合は，要素を持たないサイズ0の属性のセットを指定するのと同じ動作になります。

2.8.2　オブジェクトのリストの取得で指定できる値

オブジェクトのリストを取得する場合に，指定できる値を次に示します。

フィルター条件

フィルター条件はjava.lang.String型で定義されています。指定できる値は，java.lang.String型の範囲に従います。

なお，nullを指定した場合は，対象となるすべてのオブジェクトが取得対象になります。

ソート条件

ソート条件はjava.lang.String型で定義されています。指定できる値は，java.lang.String型の範囲に従います。

なお，nullを指定した場合は，ソートは行われません。

オフセット

オフセットはint型で定義されています。

なお，0未満の値は指定できません。0を先頭として指定してください。

最大取得件数

最大取得件数はint型で定義されています。

なお，-1未満の値は指定できません。また，-1を指定した場合は，すべてを取得します。

取得する属性セット

取得する属性のセットについては，「2.8.1　オブジェクトの取得で指定できる値」を参照してください。

2.8.3　更新系APIで指定できる値

更新系APIで指定できる値を次に示します。更新系APIの種類については，「付録A.1　更新系API」を参照してください。

日付

日付はjava.util.Date型で定義されています。

なお，nullを指定した場合は，日付情報にはnullが設定されます。

注意事項を次に示します。

日付の設定は，ミリ秒以下については切り捨てます。

日付の有効範囲は，1970/01/02 00:00:00 GMT〜292278993/12/31 00:00:00 GMTの範囲です。ただし，無限遠の過去および未来は，CIWUtil.InfinityDateで定義されているため，それぞれを表すjava.util.Date型を生成して指定した場合は，有効範囲外でも正常に動作します。

優先度

優先度はjava.lang.Integer型で定義されています。指定できる値は，java.lang.Integer型の範囲に従います。

なお，nullを指定した場合は，優先度にはnullが設定されます。

状態

状態はオブジェクトごとのState列挙型で定義されています。指定できる値は，オブジェクトごとのState列挙型に存在する定数です。

ビジネスプロセス定義名

ビジネスプロセス定義名はjava.lang.String型で定義されています。

なお，空文字列およびnullは指定できません。

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンはjava.lang.Short型で定義されています。

なお，nullを指定した場合は，ビジネスプロセス定義の中で最新バージョンが設定されます。

案件属性のマップ

案件属性のマップはjava.util.Map型で定義されています。案件属性のマップは，案件生成時にユーザが指定できる属性のマップです。

なお，nullを指定した場合は，要素を持たないサイズ0の案件属性のマップを指定した場合と同じ動作になります。

マップの要素として指定できる属性を次に示します。

案件名

案件名はjava.lang.String型で定義されています。

なお，nullを指定した場合は，案件名にはnullが設定されます。また，空文字列は指定できません。

処理期限

処理期限については，「日付」を参照してください。

優先度

優先度については，「優先度」を参照してください。

作業者ID

作業者IDはjava.lang.String型で定義されています。

なお，nullを指定した場合は，作業者IDにはnullが設定されます。また，空文字は指定できません。

注意事項を次に示します。

作業者IDは，<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数以下になるように設定してください。

2.8.4　その他のクラスで指定できる値

その他のクラスで指定できる値を次に示します。

件数を取得する対象

件数を取得する対象は，CIWServerのgetListCountで指定できます。CIWServer.Targetkind列挙型で定義されています。

指定できる値は，CIWServer.Targetkind列挙型に存在する定数です。

ユーザ記述子

ユーザ記述子は，CIWFactoryのcreateCIWServerメソッドで指定できます。java.lang.String型で定義されています。

なお，空文字列およびnullは指定できません。

注意事項を次に示します。

ユーザ記述子は，<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数以下になるように設定してください。

データソースオブジェクト

データソースオブジェクトは，CIWAdmin#initializeCIWFactoryメソッドおよびCIWFactoryのcreateCIWServerメソッドで指定できます。javax.sql.DataSource型で定義されています。

なお，nullは指定できません。

CIWFactoryのcreateCIWServerメソッドでは，次に示す場合だけ指定できます。

J2EEサーバ上のEJBから利用するなど，DataSourceから取得したjava.sql.Connectionが，実行スレッドで同一のトランザクションを使用してデータソースにアクセスできる場合（DBConnectorを使用する場合）

データベースコネクション

データベースコネクションは，CIWConnectionCoordinatorのattachDatabaseConnectionメソッドで指定できます。java.sql.Connection型で定義されています。

なお，nullは指定できません。また，自動コミット機能は無効に設定してください。

2.9　CSCIWで管理するトランザクション

初期化処理・終了処理，および運用中のID採番処理におけるトランザクションは，CSCIWが管理します。そのため，コネクションは業務プログラムで使用しているものとは別に独自に取得して利用します。ID採番処理など複数のスレッドから同時に要求される処理であっても，同時に実行するトランザクションは最大1つになるように制御します。コネクションオブジェクトそのものも，同時に使用するのは1つだけです。

業務プログラムがJavaアプリケーションの場合，CIWAdminクラスのinitializeCIWFactoryメソッドの引数に渡すデータソースでは，グローバルトランザクションは使用できません。初期化処理・終了処理，および運用中のID採番処理で使用するコネクションは，CIWAdminクラスのinitializeCIWFactoryメソッドの引数で渡されたデータソースから取得します。CSCIWがトランザクションを管理するため，java.sql.Connectionのコミットおよびロールバックメソッドを使用できる必要があります。

2.10　業務プログラムで管理するトランザクション

APIを実行する場合は，業務プログラムのトランザクションとCSCIWが利用するトランザクションを，同一トランザクションで処理します。これをトランザクション共有といいます。

トランザクションは，CSCIWでは管理しないため，業務プログラム側で管理する必要があります。

2.10.1　CIWServerとコネクションの関連づけ

CIWServerとコネクションの関連づけは，CIWConnectionCoordinatorクラスを使用するか，またはJ2EEサーバが提供するデータソースを使用することで実行できます。

(1)　CIWConnectionCoordinatorを使用したConnectionオブジェクトの関連づけ

コネクションを直接共有するために，CIWConnectionCoordinatorクラスを使用し，コネクションオブジェクトとCIWServerオブジェクトを関連づけます。

この関連づけは，CIWServerおよびCIWServerから取得するオブジェクトごとのAPIを使用する前に，必ず実施してください。関連づけを行わないでAPIを実行した場合は，例外が発生します。

また，トランザクションを終了する前に，コネクションとCIWServerとの関連づけを解除する必要があります。なお，関連づけの解除時は，CSCIWではトランザクション操作およびコネクションオブジェクトのclose()は行いません。

コネクションの関連づけのタイミングとトランザクションの範囲を次の図に示します。

図2‒6　コネクションの関連づけのタイミングとトランザクションの範囲

関連づけの機能は，JavaアプリケーションおよびJ2EEサーバ上で使用する場合に使用できます。

(2)　データソースを使用したConnectionオブジェクトの関連づけ

J2EEサーバ上でDBConnectorを利用する場合だけ，J2EEサーバが提供するデータソース（DBConnector）オブジェクトとCIWServerを直接関連づけることができます。ただし，J2EEサーバ上でDBConnectorを利用する場合でも，JDBCのデータソースを直接使用することはできません。

データソースの関連づけは，CIWServer生成時に行います。関連づけたデータソースは，オブジェクトが消滅するまで有効です。

なお，CIWServerから生成するオブジェクトは，CIWServerに関連づけられたデータソースを参照します。したがって，CIWServerから生成されたオブジェクトよりもCIWServerが先に消滅した場合でも，関連づけられたデータソースを参照し続けます。

2.10.2　Javaオブジェクト呼び出しとコネクションの関連づけ

条件，振り分けルール，生成ルール，または作業アプリケーションでJavaオブジェクト呼び出しを利用する場合，実行されるJavaオブジェクトからCIWServerに関連づけられたコネクションを利用できます。

2.10.3　トランザクションの開始

CSCIWでは，API実行時にはトランザクションを明示的に開始しません。

業務プログラムでは，CSCIWのAPIを呼び出す前に，トランザクションを開始しておく必要があります。

注意事項

CIWConnectionCoordinatorを使用してコネクションを関連づける前に，setAutoCommit()メソッドを使用し，自動コミット機能を無効にしてください。

J2EEサーバ使用時に，データソースと関連づける方式で実行する場合は，業務プログラム側でJ2EEサーバが管理するトランザクションを開始してください。開始しないと，DBConnectorやEJBの種類および設定によっては，APIと業務プログラムで発行するSQLが異なるトランザクションで実行されてしまうことがあります。この場合は，実行中に障害が発生すると，ワーク管理データベースと業務データベースの間で不整合が発生することがあります。

2.10.4　トランザクションの終了

CSCIWでは，APIで利用したトランザクションを終了しません。したがって，業務プログラムでトランザクションを終了してください。

また，CIWConnectionCoordinatorを利用したコネクションの関連づけを行っている場合は，トランザクションを終了する前に関連づけを解除してください。

2.11　業務プログラムとデータベース間での文字コード

CSCIWでは，文字コード変換を行いません。したがって，業務プログラムとデータベースで文字コードが異なる場合は，業務プログラム内で文字コード変換を行うか， JDBCおよびデータベースの機能を利用してください。

2.12　API利用時の注意事項

2.12.1　スレッドからの利用について

スレッド利用時の留意点を次に示します。

CIWFactoryは，複数のスレッドからアクセスできます。

CIWServerおよびCIWServerから生成する各種オブジェクトは，1つのスレッドからだけアクセスできます。複数のスレッドから関連するオブジェクトに同時にアクセスしないでください。

2.12.2　CSCIWManagementServerを停止した状態でのAPI実行について

J2EEサーバ上でCSCIWを使用する場合に，CSCIWManagementServerを停止した状態でAPIを実行すると，CIWFatalExceptionが発生します。CSCIWManagementServerを再起動することで再び使用できます。この場合は，取得済みのオブジェクトは再取得する必要はありません。取得済みのオブジェクトは，そのまま使用できます。

2.12.3　エラーが発生した場合のトランザクションの終了について

API実行中にエラーが発生した場合は，必ずロールバックでトランザクションを終了してください。コミットで終了すると，データに不整合が発生する場合があります。

2.12.4　排他およびデッドロックについて

排他およびデッドロックについて，次に示すことに注意してください。

同じトランザクション内で複数の更新系のメソッドを使用すると，デッドロックが発生するおそれがあります。同じトランザクション内で複数の更新系のメソッドを使用しないでください。ただし，1つの更新系のメソッドと更新系以外のメソッドは，同一トランザクション内でも使用できます。

トランザクションの開始から終了までの間隔は，できるだけ短くしてください。また，更新系のメソッドを呼び出した場合は，できるだけ早くコミットまたはロールバックしてください。複数のプログラムで実行しているときなどに，排他待ちが発生して処理速度が低下することがあります。

2.12.5　finalize()メソッド内での使用について

すべてのクラスおよびインタフェースのAPIは，finalize()メソッド内で使用しないでください。

2.12.6　参照系APIの使用について

参照系APIを使用する際には，次に示すことに注意してください。CSCIWで使用する参照系APIの種類については，「付録A.2　参照系API」を参照してください。

CSCIWの参照系APIは，SQL発行時に次に示すオプションを使用して排他（行ロック）をかけないで検索を実行しています。そのため，別トランザクションの処理で検索対象行の内容が変更されているおそれがあります。

HiRDB：WITHOUT LOCK NOWAIT

Oracle：FOR UPDATE句など，何も指定しない

SQL：

SQLServerReadMode※ = 0の場合，WITH(ROWLOCK, NOLOCK)

SQLServerReadMode※ = 1の場合，WITH(READCOMMITTED)

注※　CSCIWセットアッププロパティファイルの設定です。

なお，排他をかけないで検索を実行した場合の動作は，データベース種別ごとに異なります。動作の詳細については，ご利用のデータベースのマニュアルを参照してください。

3　提供API一覧

この章では，CSCIWが提供するJava APIの概要を一覧形式で説明します。また，パッケージ「jp.co.Hitachi.soft.csciw」およびパッケージ「jp.co.Hitachi.soft.csciw.callback」の階層関係も示します。

3.1　クラスの一覧

クラスの一覧をパッケージごとに示します。各表では，クラスを役割によって分類し，クラスおよびインタフェースごとにアルファベット順で記載しています。

ヒント

BPMN連携機能を使用する場合にCSCIWで使用するAPIについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引」を参照してください。

3.1.1　パッケージ「jp.co.Hitachi.soft.csciw」に所属するクラス

パッケージ「jp.co.Hitachi.soft.csciw」に所属するクラスの一覧を表3-1から表3-5に示します。

初期化・終了クラス

表3‒1　初期化・終了クラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）

クラス名

説明

CIWAdmin

CSCIWの初期化処理と終了処理をします。

案件実行・運用クラスおよびインタフェース

表3‒2　案件実行・運用クラスおよびインタフェースの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）

クラス名および

インタフェース名

説明

CIWActivityInstance

業務ステップのインタフェースです。

業務ステップの属性取得，属性変更，状態変更，条件評価などのメソッドを提供します。

CIWFactory

CIWServerオブジェクトのファクトリクラスです。

CIWServerオブジェクトを生成します。

CIWProcessDefinition

ビジネスプロセス定義のインタフェースです。

ビジネスプロセス定義の属性取得メソッドを提供します。

CIWProcessInstance

案件のインタフェースです。

案件の属性取得，属性変更，状態変更，強制終了などのメソッドを提供します。

CIWServer

ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェースです。次に示すメソッドを提供します。

案件の投入

案件，業務ステップ，作業，ビジネスプロセス定義などのオブジェクトおよびリストの取得

CIWWorkDefinition

作業定義のインタフェースです。

CIWWorkItem

作業のインタフェースです。

作業の属性取得，属性変更，状態変更，条件評価，作業者変更などのメソッドを提供します。

その他のクラス

表3‒3　その他のクラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）

クラス名

説明

CIWConnectionCoordinator

JDBCコネクションとCIWServerオブジェクトの関連づけをするクラスです。

CIWUtil

各種ユーティリティ機能を提供するクラスです。

列挙型

表3‒4　列挙型の一覧（パッケージ「jp.co.Hitachi.soft.csciw」）

列挙型名

説明

CIWActivityInstance.AttributeName

業務ステップ属性の属性名の列挙型です。

CIWActivityInstance.State

業務ステップの状態の列挙型です。

CIWActivityInstance.Type

業務ステップの種類の列挙型です。

CIWProcessDefinition.AttributeName

ビジネスプロセス定義属性の属性名の列挙型です。

CIWProcessDefinition.State

ビジネスプロセス定義の状態の列挙型です。

CIWProcessInstance.AttributeName

案件属性の属性名の列挙型です。

CIWProcessInstance.State

案件の状態の列挙型です。

CIWServer.Targetkind

ワーク管理システムが管理するオブジェクトの種別を表す列挙型です。

CIWUtil.InfinityDate

無限遠の日付の列挙型です。

CIWWorkDefinition.AttributeName

作業定義属性の属性名の列挙型です。

CIWWorkDefinition.Type

作業定義の種類の列挙型です。

CIWWorkItem.AttributeName

作業属性の属性名の列挙型です。

CIWWorkItem.State

作業の状態の列挙型です。

CIWWorkItem.Type

作業の種類の列挙型です。

例外クラス

表3‒5　例外クラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）

クラス名

説明

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合にスローされる例外クラスです。

CIWException

CSCIWで発生する例外の基底となる抽象クラスです。

CIWFatalException

CSCIWで処理を続行できない障害が発生した場合にスローされる例外クラスです。

CIWSQLException

DBMSで処理を続行できない障害が発生した場合にスローされる例外クラスです。

CIWSQLTransientException※

DBMSの一時的な要因で処理を実行できない場合にスローされる例外クラスです。

CIWStateException

不正な状態に関する例外クラスです。

CIWTransientException

一時的な要因で処理を実行できない場合にスローされる例外クラスです。

CIWTransitionFailedException

案件処理中にエラーが発生した場合にスローされる例外クラスです。

注※

デフォルトでは，すべてのデータベースアクセスのエラーがCIWSQLExceptionになります。環境設定ファイルに一時的エラーとして扱うSQLコードを定義すると，CIWSQLExceptionの代わりにCIWSQLTransientExceptionをスローします。

3.1.2　パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属するクラス

パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属するクラスの一覧を表3-6から表3-8に示します。

Javaオブジェクト呼び出しのインタフェース

表3‒6　インタフェースの一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）

クラス名

説明

CIWConditionEvaluator

条件Javaオブジェクトのインタフェースです。条件Javaオブジェクトで実装する必要があります。

CIWCreationRuleEvaluator

生成ルールJavaオブジェクトのインタフェースです。生成ルールJavaオブジェクトで実装する必要があります。

CIWResourceSelector

振り分けルールJavaオブジェクトのインタフェースです。振り分けルールJavaオブジェクトで実装する必要があります。

CIWWorkApplication

作業アプリケーションJavaオブジェクトのインタフェースです。作業アプリケーションJavaオブジェクトで実装する必要があります。

列挙型

表3‒7　列挙型の一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）

クラス名

説明

CIWConditionEvaluator.Parameter

条件Javaオブジェクトに渡されるパラメタキーの列挙型です。

CIWCreationRuleEvaluator.Parameter

生成ルールJavaオブジェクトに渡されるパラメタキーの列挙型です。

CIWResourceSelector.Parameter

振り分けルールJavaオブジェクトに渡されるパラメタキーの列挙型です。

CIWWorkApplication.Parameter

作業アプリケーションJavaオブジェクトに渡されるパラメタキーの列挙型です。

CIWWorkApplication.Result

作業アプリケーションの業務処理結果の列挙型です。

例外クラス

表3‒8　例外クラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）

クラス名

説明

CIWUserException

Javaオブジェクト呼び出し時の例外クラスです。

3.2　クラスの構成

CSCIWのクラスの構成をパッケージごとに示します。

3.2.1　パッケージ「jp.co.Hitachi.soft.csciw」のクラス構成

パッケージ「jp.co.Hitachi.soft.csciw」のクラス構成を次の図に示します。

図3‒1　パッケージ「jp.co.Hitachi.soft.csciw」のクラス構成

3.2.2　パッケージ「jp.co.Hitachi.soft.csciw.callback」のクラス構成

パッケージ「jp.co.Hitachi.soft.csciw.callback」のクラス構成を次の図に示します。

図3‒2　パッケージ「jp.co.Hitachi.soft.csciw.callback」のクラス構成

3.3　パッケージ「jp.co.Hitachi.soft.csciw」の階層

パッケージ「jp.co.Hitachi.soft.csciw」の階層を分類別に示します。

3.3.1　初期化・終了クラスの階層

初期化・終了クラスの階層を示します。

java.lang.Object
 └jp.co.Hitachi.soft.csciw.CIWAdmin

3.3.2　案件実行・運用クラスおよびインタフェースの階層

案件実行・運用クラスおよびインタフェースの階層を示します。

java.lang.Object
 └jp.co.Hitachi.soft.csciw.CIWFactory

interface jp.co.Hitachi.soft.csciw.CIWActivityInstance
interface jp.co.Hitachi.soft.csciw.CIWProcessDefinition
interface jp.co.Hitachi.soft.csciw.CIWProcessInstance
interface jp.co.Hitachi.soft.csciw.CIWServer
interface jp.co.Hitachi.soft.csciw.CIWWorkDefinition
interface jp.co.Hitachi.soft.csciw.CIWWorkItem

3.3.3　その他の階層

その他の階層を示します。

java.lang.Object
 ├jp.co.Hitachi.soft.csciw.CIWConnectionCoordinator
 └jp.co.Hitachi.soft.csciw.CIWUtil

3.3.4　列挙型の階層

列挙型の階層を示します。

java.lang.Object
 ├java.lang.Enum<CIWActivityInstance.AttributeName>
 │ └jp.co.Hitachi.soft.csciw.CIWActivityInstance.AttributeName
 ├java.lang.Enum<CIWActivityInstance.State>
 │ └jp.co.Hitachi.soft.csciw.CIWActivityInstance.State
 ├java.lang.Enum<CIWActivityInstance.Type>
 │ └jp.co.Hitachi.soft.csciw.CIWActivityInstance.Type
 ├java.lang.Enum<CIWProcessDefinition.AttributeName>
 │ └jp.co.Hitachi.soft.csciw.CIWProcessDefinition.AttributeName
 ├java.lang.Enum<CIWProcessDefinition.State>
 │ └jp.co.Hitachi.soft.csciw.CIWProcessDefinition.State
 ├java.lang.Enum<CIWProcessInstance.AttributeName>
 │ └jp.co.Hitachi.soft.csciw.CIWProcessInstance.AttributeName
 ├java.lang.Enum<CIWProcessInstance.State>
 │ └jp.co.Hitachi.soft.csciw.CIWProcessInstance.State
 ├java.lang.Enum<CIWServer.Targetkind>
 │ └jp.co.Hitachi.soft.csciw.CIWServer.Targetkind
 ├java.lang.Enum<CIWUtil.InfinityDate>
 │ └jp.co.Hitachi.soft.csciw.CIWUtil.InfinityDate
 ├java.lang.Enum<CIWWorkDefinition.AttributeName>
 │ └jp.co.Hitachi.soft.csciw.CIWWorkDefinition.AttributeName
 ├java.lang.Enum<CIWWorkDefinition.Type>
 │ └jp.co.Hitachi.soft.csciw.CIWWorkDefinition.Type
 ├java.lang.Enum<CIWWorkItem.AttributeName>
 │ └jp.co.Hitachi.soft.csciw.CIWWorkItem.AttributeName
 ├java.lang.Enum<CIWWorkItem.State>
 │ └jp.co.Hitachi.soft.csciw.CIWWorkItem.State
 └java.lang.Enum<CIWWorkItem.Type>
    └jp.co.Hitachi.soft.csciw.CIWWorkItem.Type

3.3.5　例外クラスの階層

例外クラスの階層を示します。

java.lang.Object
 └java.lang.Throwable (implements java.io.Serializable)
    └java.lang.Exception
       └jp.co.Hitachi.soft.csciw.CIWException
          ├jp.co.Hitachi.soft.csciw.CIWEntityNotExistException
          ├jp.co.Hitachi.soft.csciw.CIWFatalException
          │ └jp.co.Hitachi.soft.csciw.CIWSQLException
          ├jp.co.Hitachi.soft.csciw.CIWStateException
          ├jp.co.Hitachi.soft.csciw.CIWTransientException
          │ └jp.co.Hitachi.soft.csciw.CIWSQLTransientException
          └jp.co.Hitachi.soft.csciw.CIWTransitionFailedException

3.4　パッケージ「jp.co.Hitachi.soft.csciw.callback」の階層

パッケージ「jp.co.Hitachi.soft.csciw.callback」の階層を分類別に示します。

3.4.1　インタフェースの階層

インタフェースの階層を示します。

java.lang.Object

interface jp.co.Hitachi.soft.csciw.callback.CIWConditionEvaluator
interface jp.co.Hitachi.soft.csciw.callback.CIWCreationRuleEvaluator
interface jp.co.Hitachi.soft.csciw.callback.CIWResourceSelector
interface jp.co.Hitachi.soft.csciw.callback.CIWWorkApplication

3.4.2　列挙型の階層

列挙型の階層を示します。

java.lang.Object
 └java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
    └CIWConditionEvaluator.Parameter
    └CIWCreationRuleEvaluator.Parameter
    └CIWResourceSelector.Parameter
    └CIWWorkApplication.Parameter
    └CIWWorkApplication.Result

3.4.3　例外クラスの階層

例外クラスの階層を示します。
java.lang.Object
 └java.lang.Throwable (implements java.io.Serializable)
    └java.lang.Exception
       └CIWUserException

第2編　リファレンス編（パッケージ「jp.co.Hitachi.soft.csciw」に所属するAPI）

4　初期化・終了クラスが提供するメソッド

この章では，初期化・終了クラスが提供するメソッドについて説明します。

4.1　記述形式

4.1.1　初期化・終了クラスの記述形式

初期化・終了クラスは，次に示す形式を基本として説明しています。

クラス定義

クラス定義を示します。

メソッド

クラスのメソッドを説明します。

4.1.2　初期化・終了クラスが提供するメソッドの記述形式

初期化・終了クラスが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名

メソッドが所属するクラス名を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

4.2　CIWAdmin（CSCIWの初期化・終了処理をするクラス）

CSCIWの初期化および終了処理をするクラスです。

このクラスは，Javaアプリケーションでだけ使用できます。J2EEアプリケーションで使用した場合の動作は保証しません。

クラス定義

public final class CIWAdmin extends java.lang.Object

メソッド

CIWAdminクラスのメソッドを次の表に示します。

表4‒1　CIWAdminクラスのメソッド

メソッド名

説明

finalizeCIWFactory

CSCIWの終了処理をします。

initializeCIWFactory

CSCIWを初期化します。

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，toString，wait，wait，wait

finalizeCIWFactory

クラス名：CIWAdmin

構文

public static void finalizeCIWFactory()

機能

CSCIWの終了処理をします。

引数

ありません。

注意事項

このメソッドは，プロセスで一度だけ呼び出してください。複数回呼び出した場合の動作は保証しません。

このメソッドを呼び出したあとに，CSCIWのすべてのAPIを呼び出さないでください。呼び出した場合の動作は保証しません。

initializeCIWFactory

クラス名：CIWAdmin

構文

public static void initializeCIWFactory(
     javax.sql.DataSource aDataSource
)
     throws CIWFatalException

機能

CSCIWを初期化します。

引数

initializeCIWFactoryの引数を次の表に示します。

表4‒2　initializeCIWFactoryの引数

仮引数名

名称

in/out

説明

aDataSource

データソースオブジェクト

in

CSCIWのワーク管理データベースにアクセスできるデータソースオブジェクトを指定します。

データソースオブジェクトに指定できるのは，引数なしのgetConnection()メソッドを実行したときに，CSCIWのワーク管理データベースにアクセスするためのjava.sql.Connectionオブジェクトを取得できるオブジェクトです。

指定されたデータソースを使用したトランザクションは，CSCIWが管理します。そのため，java.sql.Connectionのコミットおよびロールバックメソッドを使用できる必要があります。

グローバルトランザクションは使用できません。

nullは指定できません。

メモ

データソース実装クラスとして，oracle.jdbc.pool.OracleDataSourceクラスを使用する場合は，次に示す3項目が設定されていれば問題ありません。

JDBCのURL

JDBCのURLについての詳細は使用するDBMSのマニュアルを参照してください。

接続ユーザ名

接続パスワード

データソース実装クラスとして，JP.co.Hitachi.soft.HiRDB.JDBC.PrdbDataSourceクラスを使用する場合は，次に示す4項目が設定されていれば問題ありません。

接続付加情報

ホスト名

認可識別子

接続パスワード

データソース実装クラスとして，com.microsoft.sqlserver.jdbc.SQLServerDataSourceクラスを使用する場合は，次に示す5項目が設定されていれば問題ありません。

ホスト名

ポート番号

ユーザ名

パスワード

データベース名

例外

initializeCIWFactoryで発生する例外を次の表に示します。

表4‒3　initializeCIWFactoryで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

このメソッドは，プロセスで一度だけ呼び出してください。複数回呼び出した場合の動作は保証しません。

データソースオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

5　案件実行・運用クラスおよびインタフェースが提供するメソッド

この章では，案件実行・運用クラスおよびインタフェースが提供するメソッドについて説明します。

5.1　記述形式

5.1.1　案件実行・運用クラスおよびインタフェースの記述形式

案件実行・運用クラスおよびインタフェースは，次に示す形式を基本として説明しています。

クラス定義

クラス定義を示します。

入れ子のクラス

インタフェースの入れ子のクラスを説明します。

メソッド

メソッドを説明します。

5.1.2　案件実行・運用クラスおよびインタフェースが提供するメソッドの記述形式

案件実行・運用クラスおよびインタフェースが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名またはインタフェース名

メソッドが所属するクラス名またはインタフェース名を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

5.2　CIWActivityInstance（業務ステップのインタフェース）

業務ステップのインタフェースです。

業務ステップオブジェクトに対してメソッドを発行することで，対象となる業務ステップオブジェクトに対して処理が行われます。

クラス定義

public interface CIWActivityInstance

入れ子のクラス

CIWActivityInstanceの入れ子のクラスを次の表に示します。

表5‒1　CIWActivityInstanceの入れ子のクラス

クラス名

説明および記述形式

CIWActivityInstance.AttributeName

業務ステップ属性の属性名の列挙型です。

static class CIWActivityInstance.AttributeName

CIWActivityInstance.State

業務ステップの状態の列挙型です。

static class CIWActivityInstance.State

CIWActivityInstance.Type

業務ステップの種類の列挙型です。

static class CIWActivityInstance.Type

メソッド

CIWActivityInstanceインタフェースのメソッドを次の表に示します。

表5‒2　CIWActivityInstanceインタフェースのメソッド

メソッド名

説明

adhocMakeTransition

対象となる業務ステップから指定した業務ステップに遷移します。

changeState

対象となる業務ステップの状態を変更します。

evaluate

対象となる業務ステップに対して，業務ステップに含まれる作業の開始条件，およびその業務ステップ自身の完了条件を評価します。

getActivityDefinitionID

対象となる業務ステップ定義のIDを取得します。

getActivityDefinitionName

対象となる業務ステップ定義の名称を取得します。

getClosedDate

対象となる業務ステップの終了日時を取得します。

getDeadline

対象となる業務ステップの処理期限の絶対日時を取得します。

getID

対象となる業務ステップのIDを取得します。

getName

対象となる業務ステップの名称（業務ステップキー）を取得します。

getPriority

対象となる業務ステップの優先度を取得します。

getProcessDefinitionID

対象となる業務ステップの所属するビジネスプロセス定義のIDを取得します。

getProcessInstanceID

対象となる業務ステップが所属する案件のIDを取得します。

getProcessInstanceName

対象となる業務ステップの案件名（案件キー）を取得します。

getStartDate

対象となる業務ステップの開始日時を取得します。

getState

対象となる業務ステップの状態を取得します。

getType

対象となる業務ステップの種類を取得します。

makeBackwardTransition

対象となる業務ステップに対して，指定した業務ステップ定義に差し戻しまたは引き戻しをします。

setDeadline

対象となる業務ステップに対して，指定した日時の値を業務ステップの処理期限の絶対日時として設定します。

setPriority

対象となる業務ステップの優先度を変更します。

adhocMakeTransition

インタフェース名：CIWActivityInstance

構文

void adhocMakeTransition(
     java.lang.Integer aActivityInstanceID
)
     throws CIWFatalException,
            CIWTransientException,
            CIWTransitionFailedException,
            CIWStateException,
            CIWEntityNotExistException

機能

対象となる業務ステップから指定した業務ステップに遷移します。

この操作によって，対象となる業務ステップの状態は「遷移済」に，遷移先の業務ステップの状態は「実行中」になります。

引数

adhocMakeTransitionの引数を次の表に示します。

表5‒3　adhocMakeTransitionの引数（CIWActivityInstanceの場合）

仮引数名

名称

in/out

説明

aActivityInstanceID

遷移先の業務ステップのID

in

遷移先の業務ステップのIDを指定します。遷移先には「初期」状態の業務ステップのIDを指定する必要があります。

戻り値

ありません。

例外

adhocMakeTransitionで発生する例外を次の表に示します。

表5‒4　adhocMakeTransitionで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWStateException

状態や属性の変更に失敗した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

対象となる業務ステップが所属する案件は，「実行中」または「実行停止」状態である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

対象となる業務ステップの状態は，「実行中」または「遷移可」である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

遷移先の業務ステップが存在しない場合，例外（CIWEntityNotExistException）が発生します。

遷移先の業務ステップの状態が「初期」の場合に遷移できます。そのほかの状態では，例外（CIWStateException）が発生します。

遷移先の業務ステップのIDの指定値がnullの場合は，例外（java.lang.IllegalArgumentException）が発生します。

対象となる業務ステップが所属する案件のビジネスプロセス定義のプロパティ「アドホックAPIを使用する」にチェックが入っていない場合は，例外（CIWFatalException）が発生します。

changeState

インタフェース名：CIWActivityInstance

構文

void changeState(
     CIWActivityInstance.State aNewState
)
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる業務ステップの状態を変更します。

引数

changeStateの引数を次の表に示します。

表5‒5　changeStateの引数（CIWActivityInstanceの場合）

仮引数名

名称

in/out

説明

aNewState

業務ステップの状態

in

変更する業務ステップの状態を指定します。

指定する値として，このインタフェースで定義されたCIWActivityInstance.State列挙型の定数を指定できます。nullは指定できません。

aNewStateで指定できる業務ステップの状態を次の表に示します。

表5‒6　aNewStateで指定できる業務ステップの状態（CIWActivityInstanceの場合）

現在の状態

指定できる状態

状態遷移の意味

定数

意味

定数

意味

INITIAL

初期

READY

実行開始可能

活性化

RUNNING

実行中

INTERMITTED

実行停止

中断

INTERMITTED

実行停止

RUNNING

実行中

再開

−

未終了

TERMINATED

強制終了

強制終了

RUNNING

実行中

READY_FOR_TRANSITION

遷移可

業務ステップ終了

（凡例）

定数：このインタフェースに定義されたCIWActivityInstance.State列挙型の定数を表します。

状態遷移については，「付録C　状態遷移モデル」を参照してください。

−：定数がないことを表します。

戻り値

ありません。

例外

changeStateで発生する例外を次の表に示します。

表5‒7　changeStateで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

業務ステップを「実行開始可能」状態へ遷移させる場合は，対象となる業務ステップが所属する案件は，「実行中」状態または「実行停止」状態である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

対象となる業務ステップが所属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。

指定した状態が現在の状態と同じ場合は，例外（CIWStateException）が発生します。

変更する業務ステップの状態にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

業務ステップを強制終了した場合は，次の業務ステップへは遷移しません。そのため，ほかに「実行中」状態の業務ステップが存在しない場合は，案件の強制終了以外の操作ができなくなるので注意してください。また，実行中の業務ステップが存在した場合でも，待合ノードに続く業務ステップを強制終了すると，待合ノードから遷移しなくなります。注意してください。

evaluate

インタフェース名：CIWActivityInstance

構文

void evaluate()
      throws CIWTransientException,
             CIWTransitionFailedException,
             CIWFatalException,
             CIWEntityNotExistException,
             CIWStateException

機能

対象となる業務ステップに対して，業務ステップに含まれる作業の開始条件，およびその業務ステップ自身の完了条件を評価します。

引数

ありません。

戻り値

ありません。

例外

evaluateで発生する例外を次の表に示します。

表5‒8　evaluateで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

対象となる業務ステップは，「実行中」状態である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

対象となる業務ステップが所属する案件は，「実行中」状態または「実行停止」状態である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

getActivityDefinitionID

インタフェース名：CIWActivityInstance

構文

java.lang.Integer getActivityDefinitionID()
     throws CIWFatalException

機能

対象となる業務ステップ定義のIDを取得します。

引数

ありません。

戻り値

業務ステップ定義のIDを返します。

例外

getActivityDefinitionIDで発生する例外を次の表に示します。

表5‒9　getActivityDefinitionIDで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

アドホック生成された業務ステップまたはエラー回復した業務ステップの場合は，nullが返されます。

オブジェクト取得時に業務ステップ定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getActivityDefinitionName

インタフェース名：CIWActivityInstance

構文

java.lang.String getActivityDefinitionName()
     throws CIWFatalException

機能

対象となる業務ステップ定義の名称を取得します。

引数

ありません。

戻り値

業務ステップ定義の名称を返します。

例外

getActivityDefinitionNameで発生する例外を次の表に示します。

表5‒10　getActivityDefinitionNameで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に業務ステップ定義の名称の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getClosedDate

インタフェース名：CIWActivityInstance

構文

java.util.Date getClosedDate()
     throws CIWFatalException

機能

対象となる業務ステップの終了日時を取得します。

引数

ありません。

戻り値

業務ステップの終了日時を返します。

例外

getClosedDateで発生する例外を次の表に示します。

表5‒11　getClosedDateで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

「終了」状態への遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に終了日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getDeadline

インタフェース名：CIWActivityInstance

構文

java.util.Date getDeadline()
     throws CIWFatalException

機能

対象となる業務ステップの処理期限の絶対日時を取得します。

引数

ありません。

戻り値

業務ステップの処理期限の絶対日時を返します。

例外

getDeadlineで発生する例外を次の表に示します。

表5‒12　getDeadlineで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に処理期限の絶対日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getID

インタフェース名：CIWActivityInstance

構文

java.lang.Integer getID()
     throws CIWFatalException

機能

対象となる業務ステップのIDを取得します。

引数

ありません。

戻り値

業務ステップのIDを返します。

例外

getIDで発生する例外を次の表に示します。

表5‒13　getIDで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getName

インタフェース名：CIWActivityInstance

構文

java.lang.String getName()
     throws CIWFatalException

機能

対象となる業務ステップの名称（業務ステップキー）を取得します。

引数

ありません。

戻り値

業務ステップの名称（業務ステップキー）を返します。

例外

getNameで発生する例外を次の表に示します。

表5‒14　getNameで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に名称（業務ステップキー）の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getPriority

インタフェース名：CIWActivityInstance

構文

java.lang.Integer getPriority()
     throws CIWFatalException

機能

対象となる業務ステップの優先度を取得します。

引数

ありません。

戻り値

業務ステップの優先度を返します。

例外

getPriorityで発生する例外を次の表に示します。

表5‒15　getPriorityで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に優先度の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessDefinitionID

インタフェース名：CIWActivityInstance

構文

java.lang.Integer getProcessDefinitionID()
     throws CIWFatalException

機能

対象となる業務ステップの所属するビジネスプロセス定義のIDを取得します。

引数

ありません。

戻り値

業務ステップの所属するビジネスプロセス定義のIDを返します。

例外

getProcessDefinitionIDで発生する例外を次の表に示します。

表5‒16　getProcessDefinitionIDで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に業務ステップの所属するビジネスプロセス定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessInstanceID

インタフェース名：CIWActivityInstance

構文

java.lang.Integer getProcessInstanceID()
     throws CIWFatalException

機能

対象となる業務ステップが所属する案件のIDを取得します。

引数

ありません。

戻り値

業務ステップが所属する案件のIDを返します。

例外

getProcessInstanceIDで発生する例外を次の表に示します。

表5‒17　getProcessInstanceIDで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getProcessInstanceName

インタフェース名：CIWActivityInstance

構文

java.lang.String getProcessInstanceName()
     throws CIWFatalException

機能

対象となる業務ステップの案件名（案件キー）を取得します。

引数

ありません。

戻り値

業務ステップの案件名（案件キー）を返します。

例外

getProcessInstanceNameで発生する例外を次の表に示します。

表5‒18　getProcessInstanceNameで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に案件名（案件キー）の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getStartDate

インタフェース名：CIWActivityInstance

構文

java.util.Date getStartDate()
     throws CIWFatalException

機能

対象となる業務ステップの開始日時を取得します。

引数

ありません。

戻り値

業務ステップの開始日時を返します。

例外

getStartDateで発生する例外を次の表に示します。

表5‒19　getStartDateで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

対象となる業務ステップに「実行中」状態への遷移が発生した場合に，値が設定されます。「実行中」状態への遷移が発生していない場合は，nullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に開始日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getState

インタフェース名：CIWActivityInstance

構文

CIWActivityInstance.State getState()
     throws CIWFatalException

機能

対象となる業務ステップの状態を取得します。

引数

ありません。

戻り値

業務ステップの状態を返します。

例外

getStateで発生する例外を次の表に示します。

表5‒20　getStateで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に状態の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getType

インタフェース名：CIWActivityInstance

構文

CIWActivityInstance.Type getType()
     throws CIWFatalException

機能

対象となる業務ステップの種類を取得します。

引数

ありません。

戻り値

業務ステップの種類を返します。

例外

getActivityDefinitionNameで発生する例外を次の表に示します。

表5‒21　getActivityDefinitionNameで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に種類の取得を指定していない場合は，例外（CIWFatalException）が発生します。

makeBackwardTransition

インタフェース名：CIWActivityInstance

構文

void makeBackwardTransition(
     java.lang.String aActivityDefinitionName
)
     throws CIWFatalException,
            CIWTransientException,
            CIWTransitionFailedException,
            CIWStateException,
            CIWEntityNotExistException

機能

対象となる業務ステップに対して，指定した業務ステップ定義に差し戻しまたは引き戻しをします。

差し戻し先には初期状態または終了状態の業務ステップが存在する業務ステップ定義を指定する必要があります。

引数

makeBackwardTransitionの引数を次の表に示します。

表5‒22　makeBackwardTransitionの引数

仮引数名

名称

in/out

説明

aActivityDefinitionName

業務ステップ定義名

in

差し戻し先または引き戻し先の業務ステップ定義名を指定します。

nullは指定できません。

戻り値

ありません。

例外

makeBackwardTransitionで発生する例外を次の表に示します。

表5‒23　makeBackwardTransitionで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態や属性の変更に失敗した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

差し戻し先または引き戻し先に指定した業務ステップ定義が存在しない場合，例外（CIWEntityNotExistException）が発生します。

差し戻し先または引き戻し先に指定した業務ステップ定義に業務ステップが存在しない場合，例外（CIWStateException）が発生します。

差し戻し先または引き戻し先に指定した業務ステップ定義に「初期」状態または「終了」状態のどちらでもない状態の業務ステップが存在する場合，例外（CIWStateException）が発生します。

差し戻し先または引き戻し先の業務ステップ定義名にnullを指定した場合，例外（java.lang.IllegalArgumentException）が発生します。

対象となる業務ステップの状態が「初期」または「終了」のどちらかの場合は，例外（CIWStateException）が発生します。

対象となる業務ステップを含む案件の状態が「実行中」または「実行停止」のどちらでもない場合は，例外（CIWStateException）が発生します。

setDeadline

インタフェース名：CIWActivityInstance

構文

void setDeadline(
     java.util.Date aNewDeadline
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる業務ステップに対して，指定した日時の値を業務ステップの処理期限の絶対日時として設定します。

引数

setDeadlineの引数を次の表に示します。

表5‒24　setDeadlineの引数（CIWActivityInstanceの場合）

仮引数名

名称

in/out

説明

aNewDeadline

変更後の処理期限

in

変更後の処理期限を指定します。

nullを指定した場合は，処理期限は未設定となります。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。

なお，処理期限はミリ秒以下を切り捨てて設定します。

戻り値

ありません。

例外

setDeadlineで発生する例外を次の表に示します。

表5‒25　setDeadlineで発生する例外（CIWActivityInstanceの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

業務ステップが「未終了」状態のときだけ変更できます。ただし，業務ステップの処理期限を変更しても，対象となる業務ステップに所属する，変更以前に生成されていた作業の処理期限は変更されません。

setPriority

インタフェース名：CIWActivityInstance

構文

void setPriority(
     java.lang.Integer aNewPriority
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる業務ステップの優先度を変更します。

引数

setPriorityの引数を次の表に示します。

表5‒26　setPriorityの引数（CIWActivityInstanceの場合）

仮引数名

名称

in/out

説明

aNewPriority

変更後の優先度

in

変更後の優先度を指定します。

nullを指定した場合は，優先度は未設定となります。

戻り値

ありません。

例外

setPriorityで発生する例外を次の表に示します。

表5‒27　setPriorityで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

業務ステップが「未終了」状態のときだけ変更できます。ただし，業務ステップの優先度を変更しても，対象となる業務ステップに所属する，変更以前に生成されていた作業の優先度は変更されません。

5.3　CIWFactory（CIWFactoryとCIWServerオブジェクトの生成クラス）

CIWFactoryは，CIWServerオブジェクトのファクトリクラスです。

このクラスで次に示す処理をします。

ファクトリオブジェクトの取得

CIWServerオブジェクトの生成

クラス定義

public final class CIWFactory extends java.lang.Object

メソッド

CIWFactoryクラスのメソッドを次の表に示します。

表5‒28　CIWFactoryクラスのメソッド

メソッド

説明

createCIWServer

CIWServerオブジェクトを生成します。

createCIWServer

javax.sql.DataSourceオブジェクトを設定して，CIWServerオブジェクトを生成します。

getInstance

ファクトリオブジェクトを取得します。

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，toString，wait，wait，wait

createCIWServer

クラス名：CIWFactory

形式

public CIWServer createCIWServer(
     java.lang.String aUserDescription
)
     throws CIWFatalException

機能

CIWServerオブジェクトを生成します。

このメソッドで生成したCIWServerオブジェクトについては，トランザクションの開始しているデータベースコネクションとの関連づけおよび関連づけ解除を，ユーザ自身が行う必要があります。この場合，CIWServer#getConnectionCoordinator()を実行し，コネクション関連づけオブジェクトを取得し，データベースコネクションとCIWServerオブジェクトとの関連づけおよび関連づけ解除を行ってください。

引数

createCIWServerの引数を次の表に示します。

表5‒29　createCIWServerの引数

仮引数名

名称

in/out

説明

aUserDescription

ユーザ記述子

in

ユーザ記述子を<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数以下で指定します。

空文字列およびnullは指定できません。

戻り値

CIWServerオブジェクトを返します。

例外

createCIWServerで発生する例外を次の表に示します。

表5‒30　createCIWServerで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

ユーザ記述子に次に示す文字列を指定した場合，例外（java.lang.IllegalArgumentException）が発生します。

ユーザ記述子に<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数を超える文字列

空文字列

null

createCIWServer

クラス名：CIWFactory

形式

public CIWServer createCIWServer(
     java.lang.String aUserDescription,
     javax.sql.DataSource aDataSource
)
     throws CIWFatalException

機能

javax.sql.DataSourceオブジェクトを設定して，CIWServerオブジェクトを生成します。

このメソッドで生成したCIWServerオブジェクトについては，データベースコネクションとCIWServerオブジェクトの関連づけおよび解除は自動的に行われます。このメソッドで生成したCIWServerオブジェクトに対して，CIWServer#getConnectionCoordinator()を実行した場合は（CIWFatalException）が発生します。

引数

createCIWServerの引数を次の表に示します。

表5‒31　createCIWServerの引数

仮引数名

名称

in/out

説明

aUserDescription

ユーザ記述子

in

ユーザ記述子を<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数以下で指定します。

空文字列およびnullは指定できません。

aDataSource

データソースオブジェクト

in

ユーザアプリケーションで使用しているデータソースオブジェクトを指定します。

nullは指定できません。

戻り値

CIWServerオブジェクトを返します。

例外

createCIWServerで発生する例外を次の表に示します。

表5‒32　createCIWServerで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

ユーザ記述子に次に示す文字列を指定した場合，例外（java.lang.IllegalArgumentException）が発生します。

ユーザ記述子に<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数を超える文字列

空文字列

null

ユーザアプリケーションで使用しているDataSourceオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

DataSourceから取得したjava.sql.Connectionが，実行スレッドで同一のトランザクションでDBMSにアクセスできる場合に，このメソッドを呼び出すことができます。例えば，J2EEサーバ上のEJBから利用する場合などです。

getInstance

クラス名：CIWFactory

構文

public static CIWFactory getInstance()
     throws CIWFatalException

機能

ファクトリオブジェクトを取得します。

引数

ありません。

戻り値

ファクトリオブジェクトを返します。

例外

getInstanceで発生する例外を次の表に示します。

表5‒33　getInstanceで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

initializeCIWFactoryメソッドを実行する前に，このメソッドを実行した場合，例外（CIWFatalException）が発生します。

5.4　CIWProcessDefinition（ビジネスプロセス定義のインタフェース）

ビジネスプロセス定義のインタフェースです。

ビジネスプロセス定義オブジェクトに対してメソッドを発行することで，対象となるビジネスプロセス定義オブジェクトに対して処理が行われます。

クラス定義

public interface CIWProcessDefinition

入れ子のクラス

CIWProcessDefinitionインタフェースの入れ子のクラスを次の表に示します。

表5‒34　CIWProcessDefinitionインタフェースの入れ子のクラス

クラス名

入れ子のクラスの説明および入れ子のクラスの記述形式

CIWProcessDefinition.AttributeName

ビジネスプロセス定義属性の属性名の列挙型です。

static class CIWProcessDefinition.AttributeName

CIWProcessDefinition.State

ビジネスプロセス定義の状態の列挙型です。

static class CIWProcessDefinition.State

メソッド

CIWProcessDefinitionインタフェースのメソッドを次の表に示します。

表5‒35　CIWProcessDefinitionインタフェースのメソッド

メソッド名

説明

getAuthor

対象となるビジネスプロセス定義の作成者を取得します。

getCreationDate

対象となるビジネスプロセス定義の作成日を取得します。

getDescription

対象となるビジネスプロセス定義の説明を取得します。

getID

対象となるビジネスプロセス定義のIDを取得します。

getName

対象となるビジネスプロセス定義の名称を取得します。

getProcessInstancesList

対象となるビジネスプロセス定義内で，指定したフィルター条件を満たす案件オブジェクトのリストを取得します。

getResponsible

対象となるビジネスプロセス定義の管理者IDを取得します。

getState

対象となるビジネスプロセス定義の状態を取得します。

getValidFromDate

対象となるビジネスプロセス定義の有効となる日を取得します。

getValidToDate

対象となるビジネスプロセス定義の無効となる日を取得します。

getVersion

対象となるビジネスプロセス定義のバージョンを取得します。

getAuthor

インタフェース名：CIWProcessDefinition

構文

java.lang.String getAuthor()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の作成者を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の作成者を返します。

例外

getAuthorで発生する例外を次の表に示します。

表5‒36　getAuthorで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作成者の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getCreationDate

インタフェース名：CIWProcessDefinition

構文

java.util.Date getCreationDate()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の作成日を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の作成日を返します。

例外

getCreationDateで発生する例外を次の表に示します。

表5‒37　getCreationDateで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作成日の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getDescription

インタフェース名：CIWProcessDefinition

構文

java.lang.String getDescription()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の説明を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の説明を返します。

例外

getDescriptionで発生する例外を次の表に示します。

表5‒38　getDescriptionで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に説明の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getID

インタフェース名：CIWProcessDefinition

構文

java.lang.Integer getID()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義のIDを取得します。

引数

ありません。

戻り値

ビジネスプロセス定義のIDを返します。

例外

getIDで発生する例外を次の表に示します。

表5‒39　getIDで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getName

インタフェース名：CIWProcessDefinition

構文

java.lang.String getName()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の名称を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の名称を返します。

例外

getNameで発生する例外を次の表に示します。

表5‒40　getNameで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に名称の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessInstancesList

インタフェース名：CIWProcessDefinition

構文

java.util.List<CIWProcessInstance> getProcessInstancesList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWProcessInstance.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException

機能

対象となるビジネスプロセス定義内で，指定したフィルター条件を満たす案件オブジェクトのリストを取得します。

引数

getProcessInstancesListの引数を次の表に示します。

表5‒41　getProcessInstancesListの引数（CIWProcessDefinitionの場合）

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

案件オブジェクトを取得する場合に，フィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

案件オブジェクトを取得する場合に，ソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

案件オブジェクトを取得する場合に，オフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

案件オブジェクトを取得する場合に，最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい案件オブジェクトの属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，案件のIDは必ず取得します。取得できる属性は，CIWProcessInstance.AttributeName列挙型で指定できる属性です。

戻り値

取得した案件オブジェクトのリストを返します。

例外

getProcessInstancesListで発生する例外を次の表に示します。

表5‒42　getProcessInstancesListで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす案件オブジェクトが存在しない場合，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，案件の重複や漏れが発生することがあります。

getResponsible

インタフェース名：CIWProcessDefinition

構文

java.lang.String getResponsible()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の管理者IDを取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の管理者IDを返します。

例外

getResponsibleで発生する例外を次の表に示します。

表5‒43　getResponsibleで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に管理者IDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getState

インタフェース名：CIWProcessDefinition

構文

CIWProcessDefinition.State getState()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の状態を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の状態を返します。

例外

getStateで発生する例外を次の表に示します。

表5‒44　getStateで発生する例外（CIWProcessDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に状態の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getValidFromDate

インタフェース名：CIWProcessDefinition

構文

java.util.Date getValidFromDate()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の有効となる日を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の有効となる日を返します。

例外

getValidFromDateで発生する例外を次の表に示します。

表5‒45　getValidFromDateで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時は，無限遠の過去を表す日付情報を返します。無限遠の過去を表す日付情報については，「表7-41　CIWUtil.InfinityDateの列挙型定数」のORIGINを参照してください。

オブジェクト取得時に有効となる日の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getValidToDate

インタフェース名：CIWProcessDefinition

構文

java.util.Date getValidToDate()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義の無効となる日を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義の無効となる日を返します。

例外

getValidToDateで発生する例外を次の表に示します。

表5‒46　getValidToDateで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時は，無限遠の未来を表す日付情報を返します。無限遠の未来を表す日付情報については，「表7-41　CIWUtil.InfinityDateの列挙型定数」のBEYONDを参照してください。

オブジェクト取得時に無効となる日の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getVersion

インタフェース名：CIWProcessDefinition

構文

java.lang.Short getVersion()
     throws CIWFatalException

機能

対象となるビジネスプロセス定義のバージョンを取得します。

引数

ありません。

戻り値

ビジネスプロセス定義のバージョンを返します。

例外

getVersionで発生する例外を次の表に示します。

表5‒47　getVersionで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時にバージョンの取得を指定していない場合は，例外（CIWFatalException）が発生します。

5.5　CIWProcessInstance（案件のインタフェース）

案件のインタフェースです。

案件オブジェクトにメソッドを発行することで，対象となる案件オブジェクトに対して処理が行われます。

クラス定義

public interface CIWProcessInstance

入れ子のクラス

CIWProcessInstanceインタフェースの入れ子のクラスを次の表に示します。

表5‒48　CIWProcessInstanceインタフェースの入れ子のクラス

クラス名

説明および記述形式

CIWProcessInstance.AttributeName

案件属性の属性名の列挙型です。

static class CIWProcessInstance.AttributeName

CIWProcessInstance.State

案件の状態の列挙型です。

static class CIWProcessInstance.State

メソッド

CIWProcessInstanceインタフェースのメソッドを次の表に示します。

表5‒49　CIWProcessInstanceインタフェースのメソッド

メソッド名

説明

adhocInstantiateActivityInstance

指定した業務ステップ定義に従って，対象となる案件内に，業務ステップを「初期」状態で生成します。

changeState

対象となる案件の状態を変更します。

delete

対象となる案件を削除します。

getClosedDate

対象となる案件の終了日時を取得します。

getCreator

対象となる案件の投入者を取得します。

getDeadline

対象となる案件の処理期限の絶対日時を取得します。

getID

対象となる案件のIDを取得します。

getMovedDate

対象となる案件の乗せ替え日時を取得します。

getName

対象となる案件の名称（案件キー）を取得します。

getPriority

対象となる案件の優先度を取得します。

getProcessDefinition

対象となる案件が所属するビジネスプロセス定義オブジェクトを取得します。

getProcessDefinitionID

対象となる案件が所属するビジネスプロセス定義のIDを取得します。

getProcessDefinitionName

対象となる案件が所属するビジネスプロセス定義の名称を取得します。

getStartDate

対象となる案件の開始日時を取得します。

getState

対象となる案件の状態を取得します。

getWorkItemsList

対象となる案件内で，指定したフィルター条件を満たす作業オブジェクトのリストを取得します。

setDeadline

対象となる案件に対して，指定した日時の値を案件の処理期限の絶対日時として設定します。

setPriority

対象となる案件の優先度を変更します。

start

対象となる案件を開始させます。

startAndAdhocInstantiateActivityInstanceByADName

案件を開始し，指定した業務ステップを生成して実行状態にします。

terminate

対象となる案件を強制終了させます。

adhocInstantiateActivityInstance

インタフェース名：CIWProcessInstance

構文

CIWActivityInstance adhocInstantiateActivityInstance(
                    java.lang.Integer aActivityDefinitionID,
                    java.lang.String aActivityInstanceName
)
                    throws CIWFatalException,
                           CIWTransientException,
                           CIWStateException,
                           CIWTransitionFailedException,
                           CIWEntityNotExistException

機能

指定した業務ステップ定義に従って，対象となる案件内に，業務ステップを「初期」状態で生成します。

引数

adhocInstantiateActivityInstanceの引数を次の表に示します。

表5‒50　adhocInstantiateActivityInstanceの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aActivityDefinitionID

業務ステップ定義のID

in

業務ステップ定義のIDを指定します。

aActivityInstanceName

業務ステップの名称

in

業務ステップの名称（業務ステップキー）を指定します。<SYSTEMID>_ACTIVITY_INSTANCEテーブルのNameカラムのバイト数以下の文字列が指定できます。

nullを指定した場合，業務ステップの名称は未設定になります。

空文字は指定できません。

戻り値

生成した業務ステップオブジェクトを返します。

例外

adhocInstantiateActivityInstanceで発生する例外を次の表に示します。

表5‒51　adhocInstantiateActivityInstanceで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWStateException

状態や属性の変更に失敗した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

対象となる案件は，「未終了」状態である必要があります。それ以外の場合は，例外（CIWStateException）が発生します。

業務ステップ定義のIDには，遷移定義が存在しない業務ステップ定義のIDも指定できます。

指定した業務ステップ定義が存在しない場合，例外（CIWEntityNotExistException）が発生します。

業務ステップ定義のIDにnullを指定した場合，例外（java.lang.IllegalArgumentException）が発生します。

指定する業務ステップの名称に空文字または<SYSTEMID>_ACTIVITY_INSTANCEテーブルのNameカラムのバイト数を超える文字列を指定した場合，例外（java.lang.IllegalArgumentException）が発生します。

対象となる案件のビジネスプロセス定義のプロパティ「アドホックAPIを使用する」にチェックが入っていない場合，例外（CIWFatalException）が発生します。

changeState

インタフェース名：CIWProcessInstance

構文

void changeState(
     CIWProcessInstance.State aNewState
)
     throws CIWFatalException,
            CIWEntityNotExistException,
            CIWTransientException,
            CIWTransitionFailedException,
            CIWStateException

機能

対象となる案件の状態を変更します。

引数

changeStateの引数を次の表に示します。

表5‒52　changeStateの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aNewState

案件の状態

in

変更後の案件の状態を指定します。

指定する値として，このインタフェースに定義されたCIWProcessInstance.State列挙型の定数を指定できます。

nullは指定できません。

aNewStateで指定できる案件の状態を次の表に示します。

表5‒53　aNewStateで指定できる案件の状態（CIWProcessInstanceの場合）

現在の状態

指定できる状態

状態遷移の意味

定数

意味

定数

意味

RUNNING

実行中

INTERMITTED

実行停止

中断

INTERMITTED

実行停止

RUNNING

実行中

再開

−

未終了

TERMINATED

強制終了

強制終了

（凡例）

定数：CIWProcessInstance.State列挙型の定数

状態遷移については，「付録C　状態遷移モデル」を参照してください。

−：定数がないことを表します。

戻り値

ありません。

例外

changeStateで発生する例外を次の表に示します。

表5‒54　changeStateで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

注意事項

エラー案件に対して実行した場合は，例外（CIWStateException）が発生します。

変更する案件状態にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

delete

インタフェース名：CIWProcessInstance

構文

void delete()
      throws CIWTransientException,
             CIWFatalException,
             CIWEntityNotExistException,
             CIWStateException

機能

対象となる案件を削除します。

案件に含まれるすべての業務ステップおよび作業も同時に削除します。

引数

ありません。

戻り値

ありません。

例外

deleteで発生する例外を次の表に示します。

表5‒55　deleteで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できないような障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態や属性の変更に失敗した場合

注意事項

案件が「終了」状態の場合だけ削除できます。そのほかの状態の場合は，例外（CIWStateException）が発生します。

getClosedDate

インタフェース名：CIWProcessInstance

構文

java.util.Date getClosedDate()
     throws CIWFatalException

機能

対象となる案件の終了日時を取得します。

引数

ありません。

戻り値

案件の終了日時を返します。

例外

getClosedDateで発生する例外を次の表に示します。

表5‒56　getClosedDateで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

「終了」状態への遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に終了日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getCreator

インタフェース名：CIWProcessInstance

構文

java.lang.String getCreator()
     throws CIWFatalException

機能

対象となる案件の投入者を取得します。

引数

ありません。

戻り値

案件の投入者を返します。

例外

getCreatorで発生する例外を次の表に示します。

表5‒57　getCreatorで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

オブジェクト取得時に投入者の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getDeadline

インタフェース名：CIWProcessInstance

構文

java.util.Date getDeadline()
     throws CIWFatalException

機能

対象となる案件の処理期限の絶対日時を取得します。

引数

ありません。

戻り値

案件の処理期限の絶対日時を返します。

例外

getDeadlineで発生する例外を次の表に示します。

表5‒58　getDeadlineで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に処理期限の絶対日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getID

インタフェース名：CIWProcessInstance

構文

java.lang.Integer getID()
     throws CIWFatalException

機能

対象となる案件のIDを取得します。

引数

ありません。

戻り値

案件のIDを返します。

例外

getIDで発生する例外を次の表に示します。

表5‒59　getIDで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

getMovedDate

インタフェース名：CIWProcessInstance

構文

java.util.Date getMovedDate()
     throws CIWFatalException

機能

対象となる案件の乗せ替え日時を取得します。

引数

ありません。

戻り値

案件の乗せ替え日時を返します。

例外

getMovedDateで発生する例外を次の表に示します。

表5‒60　getMovedDateで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に乗せ替え日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getName

インタフェース名：CIWProcessInstance

構文

java.lang.String getName()
     throws CIWFatalException

機能

対象となる案件の名称（案件キー）を取得します。

引数

ありません。

戻り値

案件の名称（案件キー）を返します。

例外

getNameで発生する例外を次の表に示します。

表5‒61　getNameで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に名称（案件キー）の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getPriority

インタフェース名：CIWProcessInstance

構文

java.lang.Integer getPriority()
     throws CIWFatalException

機能

対象となる案件の優先度を取得します。

引数

ありません。

戻り値

案件の優先度を返します。

例外

getPriorityで発生する例外を次の表に示します。

表5‒62　getPriorityで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できないような障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に優先度の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessDefinition

インタフェース名：CIWProcessInstance

構文

CIWProcessDefinition getProcessDefinition(
     java.util.Set<CIWProcessDefinition.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

対象となる案件が所属するビジネスプロセス定義オブジェクトを取得します。

引数

getProcessDefinitionの引数を次の表に示します。

表5‒63　getProcessDefinitionの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aAttributeNames

属性名のセット

in

取得したいビジネスプロセス定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。 取得属性名に指定されていない場合でも，ビジネスプロセス定義のIDは必ず取得します。取得可能な属性は，CIWProcessDefinition.AttributeName列挙型で指定できる属性です。

戻り値

案件が所属するビジネスプロセス定義オブジェクトを返します。

例外

getProcessDefinitionで発生する例外を次の表に示します。

表5‒64　getProcessDefinitionで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

オブジェクト取得時に案件が所属するビジネスプロセス定義のIDの取得を指定していない場合，例外（CIWFatalException）が発生します。

getProcessDefinitionID

インタフェース名：CIWProcessInstance

構文

java.lang.Integer getProcessDefinitionID()
     throws CIWFatalException

機能

対象となる案件が所属するビジネスプロセス定義のIDを取得します。

引数

ありません。

戻り値

案件が所属するビジネスプロセス定義のIDを返します。

例外

getProcessDefinitionIDで発生する例外を次の表に示します。

表5‒65　getProcessDefinitionIDで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に案件が所属するビジネスプロセス定義のIDの取得を指定していない場合，例外（CIWFatalException）が発生します。

getProcessDefinitionName

インタフェース名：CIWProcessInstance

構文

java.lang.String getProcessDefinitionName()
     throws CIWFatalException

機能

対象となる案件が所属するビジネスプロセス定義の名称を取得します。

引数

ありません。

戻り値

案件が所属するビジネスプロセス定義の名称を返します。

例外

getProcessDefinitionNameで発生する例外を次の表に示します。

表5‒66　getProcessDefinitionNameで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に案件が所属するビジネスプロセス定義の名称の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getStartDate

インタフェース名：CIWProcessInstance

構文

java.util.Date getStartDate()
     throws CIWFatalException

機能

対象となる案件の開始日時を取得します。

引数

ありません。

戻り値

案件の開始日時を返します。

例外

getStartDateで発生する例外を次の表に示します。

表5‒67　getStartDateで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

「実行中」状態への遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に開始日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getState

インタフェース名：CIWProcessInstance

構文

CIWProcessInstance.State getState()
     throws CIWFatalException

機能

対象となる案件の状態を取得します。

引数

ありません。

戻り値

案件の状態を返します。

例外

getStateで発生する例外を次の表に示します。

表5‒68　getStateで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に状態の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getWorkItemsList

インタフェース名：CIWProcessInstance

構文

java.util.List<CIWWorkItem> getWorkItemsList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWWorkItem.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException

機能

対象となる案件内で，指定したフィルター条件を満たす作業オブジェクトのリストを取得します。

引数

getWorkItemsListの引数を次の表に示します。

表5‒69　getWorkItemsListの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

作業を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。 フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

作業を取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

作業を取得する場合のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

作業を取得する際の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい作業の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。 取得属性名に指定されていない場合でも，作業のIDと作業が所属する案件のIDは必ず取得します。取得可能な属性は，CIWWorkItem.AttributeName列挙型で指定できる属性です。

戻り値

取得した作業オブジェクトのリストを返します。

例外

getWorkItemsListで発生する例外を次の表に示します。

表5‒70　getWorkItemsListで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす作業オブジェクトが存在しない場合は，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，作業の重複や漏れが発生することがあります。

setDeadline

インタフェース名：CIWProcessInstance

構文

void setDeadline(
     java.util.Date aNewDeadline
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる案件に対して，指定した日時の値を案件の処理期限の絶対日時として設定します。

引数

setDeadlineの引数を次の表に示します。

表5‒71　setDeadlineの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aNewDeadline

変更後の処理期限

in

変更後の処理期限を指定します。

nullを指定した場合は，処理期限は未設定となります。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。処理期限はミリ秒以下については切り捨てて設定します。

戻り値

ありません。

例外

setDeadlineで発生する例外を次の表に示します。

表5‒72　setDeadlineで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

案件が「未終了」状態のときだけ変更できます。ただし，案件の処理期限を変更しても，対象となる案件に所属する，変更以前に生成されていた業務ステップの処理期限は変更されません。

setPriority

インタフェース名：CIWProcessInstance

構文

void setPriority(
     java.lang.Integer aNewPriority
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる案件の優先度を変更します。

引数

setPriorityの引数を次の表に示します。

表5‒73　setPriorityの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aNewPriority

変更後の優先度

in

変更後の優先度を指定します。

nullを指定した場合は，優先度は未設定となります。

戻り値

ありません。

例外

setPriorityで発生する例外を次の表に示します。

表5‒74　setPriorityで発生する例外（CIWProcessInstanceの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

案件が「未終了」状態のときだけ変更できます。ただし，案件の優先度を変更しても，対象となる案件に所属する，変更以前に生成されていた業務ステップの優先度は変更されません。

start

インタフェース名：CIWProcessInstance

構文

void start()
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる案件を開始させます。

引数

ありません。

戻り値

ありません。

例外

startで発生する例外を次の表に示します。

表5‒75　startで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態や属性の変更に失敗した場合

注意事項

案件が「未実行」状態の場合に開始できます。そのほかの状態の場合は，例外（CIWStateException）が発生します。

startAndAdhocInstantiateActivityInstanceByADName

インタフェース名：CIWProcessInstance

構文

void startAndAdhocInstantiateActivityInstanceByADName(
     java.util.Set
     <java.lang.String> aActivityDefinitionNames
)
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

案件を開始し，指定した業務ステップを生成して実行状態にします。

生成対象の業務ステップは，業務ステップ定義名で指定します。

引数

startAndAdhocInstantiateActivityInstanceByADNameの引数を次の表に示します。

表5‒76　startAndAdhocInstantiateActivityInstanceByADNameの引数（CIWProcessInstanceの場合）

仮引数名

名称

in/out

説明

aActivityDefinitionNames

業務ステップ定義の定義名のセット

in

業務ステップ定義の定義名のセットを指定します。

戻り値

ありません。

例外

startAndAdhocInstantiateActivityInstanceByADNameで発生する例外を次の表に示します。

表5‒77　startAndAdhocInstantiateActivityInstanceByADNameで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態や属性の変更に失敗した場合

注意事項

対象となる案件は「未実行」状態である必要があります。それ以外の場合は，例外（CIWStateException）が発生します。

待合ノードへ遷移する業務ステップを指定する場合は，待合ノードへ遷移するすべての業務ステップ定義名を指定する必要があります。

業務ステップ定義の名称には，遷移定義が存在しない業務ステップ定義の定義名も指定できます。

対象となる案件のビジネスプロセス定義のプロパティ「アドホックAPIを使用する」にチェックが入っていない場合は，例外（CIWFatalException）が発生します。

指定した業務ステップ定義が存在しない場合は，例外（CIWEntityNotExistException）が発生します。

引数aActivityDefinitionNamesにnullまはた空のセットを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

terminate

インタフェース名：CIWProcessInstance

構文

void terminate()
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる案件を強制終了させます。

引数

ありません。

戻り値

ありません。

例外

terminateで発生する例外を次の表に示します。

表5‒78　terminateで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態や属性の変更に失敗した場合

注意事項

案件が「未終了」状態の場合に強制終了できます。そのほかの状態の場合は，例外（CIWStateException）が発生します。

エラー案件に対して実行した場合は，例外（CIWStateException）が発生します。

5.6　CIWServer（ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェース）

ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェースです。

クラス定義

public interface CIWServer

入れ子のクラス

CIWServerインタフェースの入れ子のクラスを次の表に示します。

表5‒79　CIWServerインタフェースの入れ子のクラス

クラス名

説明および記述形式

CIWServer.Targetkind

ワーク管理システムが管理するオブジェクトの種別を表す列挙型です。

static class CIWServer.Targetkind

メソッド

CIWServerインタフェースのメソッドを次の表に示します。

表5‒80　CIWServerインタフェースのメソッド

メソッド名

説明

allocateWorkItemEx

指定したフィルター条件とソート条件を満たす作業群に対して，指定した割り当て先の作業者IDへ作業を割り当てます。最初に割り当てに成功した作業オブジェクトを返します。

createAndStartProcessInstance

案件属性，ビジネスプロセス定義の名称およびバージョンを指定して，案件を生成し開始します。

createProcessInstance

案件属性，ビジネスプロセス定義の名称およびバージョンを指定して，案件を生成します。

getActivityInstance

案件のIDと業務ステップのIDを指定して，業務ステップオブジェクトを取得します。

getActivityInstancesList

指定したフィルター条件を満たす業務ステップオブジェクトのリストを取得します。

getConnectionCoordinator

CIWServerオブジェクト内に保持されているコネクション関連づけオブジェクトを取得します。

getListCount

指定したフィルター条件を満たす各種オブジェクトのリスト件数を取得します。

getProcessDefinition

ビジネスプロセス定義のIDを指定して，ビジネスプロセス定義オブジェクトを取得します。

getProcessDefinitionsList

指定したフィルター条件を満たすビジネスプロセス定義オブジェクトのリストを取得します。

getProcessInstance

案件のIDを指定して，案件オブジェクトを取得します。

getProcessInstancesList

指定したフィルター条件を満たす案件オブジェクトのリストを取得します。

getWorkDefinition

ビジネスプロセス定義のIDおよび作業定義のIDを指定して，作業定義オブジェクトを取得します。

getWorkDefinitionsList

指定したフィルター条件を満たす作業定義オブジェクトのリストを取得します。

getWorkItem

案件のIDと作業のIDを指定して，作業オブジェクトを取得します。

getWorkItemsList

指定したフィルター条件を満たす作業オブジェクトのリストを取得します。

allocateWorkItemEx

インタフェース名：CIWServer

構文

public CIWWorkItem allocateWorkItemEx(
     String aParticipant,
     String aFilter,
     String aSort,
     Set<CIWWorkItem.AttributeName> aAttributeNames,
     int aFetchCount
)

機能

指定したフィルター条件とソート条件を満たす作業群に対して，指定した割り当て先の作業者IDへ作業を割り当てます。最初に割り当てに成功した作業オブジェクトを返します。

割り当てる際に，作業オブジェクトを「実行開始可能」状態から「作業者実行」状態に変更します。指定したフィルター条件を満たす作業がない場合や，作業者を割り当てられる作業がない場合はnullを返します。

フィルター条件には次の2つの条件をAND条件で自動的に追加します。

StateCodeが"j"（実行開始可能）と一致する

一般作業である

引数

allocateWorkItemExの引数を次の表に示します。

表5‒81　allocateWorkItemExの引数

仮引数名

名称

in/out

説明

aParticipant

作業者ID

in

割り当てる作業者IDを<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数以下で指定します。

nullは指定できません。

aFilter

フィルター条件

in

作業を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

作業を取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aAttributeNames

属性名のセット

in

取得したい作業の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名を指定しない場合でも，作業のID，作業が所属する案件のID，作業者のID，作業の状態，および作業の開始日時は必ず取得します。取得可能な属性は，CIWWorkItem.AttributeName列挙型で指定できる属性です。

aFetchCount

最大取得数

in

作業を取得する場合の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は設定できません。

戻り値

取得したCIWWorkItem（作業）オブジェクトを返します。取得したCIWWorkItem（作業）オブジェクトがない場合はnullを返します。

例外

allocateWorkItemExで発生する例外を次の表に示します。

表5‒82　allocateWorkItemExで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

メソッド実行直後に，トランザクションをコミットしてください。メソッド発行からコミットまでの間に，業務テーブルの更新などを実行しないでください。

このメソッドで取得した作業を返却する場合は，CIWWorkItemクラスのfreeメソッドを実行します。

引数aFetchCountで指定した数の作業群の中から，先頭の作業に対して実行します。失敗した場合は，それ以降ランダムに割り当てを実行します。つまり，順番に並んでいる作業のうち，2件目からaFetchCount分の範囲内ではソートの順番が無視されます。ソートの順番を保証するには，aFetchCountを1に指定してください。しかし，aFetchCountを1にした場合，このメソッドが同時に多数発行されると作業の割り当てが重複して，レスポンスが悪くなります。

取得した作業群に対して，一定回数（作業群の作業の４割）作業の割り当てを失敗した場合は，指定したフィルター条件とソート条件を満たす作業群を取得し直します。

割り当てる作業者IDに空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

割り当てる作業者IDに<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数を超える文字列を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

一般作業だけが対象になります。組み込み作業は対象外です。

引数aFetchCountは，同時実行するAPIの数より多く指定してください。少ない場合，同時実行されたAPI同士の衝突が多く発生し，効率が悪くなります。

Oracleはダーティリードをサポートしていません。そのため，コミットしていないの別トランザクションの更新を読み取れません。その結果，Oracleを利用している場合は，APIの更新処理が同時に複数実行できないため効率的に処理ができません。

createAndStartProcessInstance

インタフェース名：CIWServer

構文

CIWProcessInstance createAndStartProcessInstance(
     java.util.Map
     <CIWProcessInstance.AttributeName,java.lang.Object> aAttributes,
     java.lang.String aProcessDefinitionName,
     java.lang.Short aVersion
)
     throws CIWFatalException,
     CIWTransitionFailedException,
     CIWTransientException,
     CIWEntityNotExistException

機能

案件属性，ビジネスプロセス定義の名称およびバージョンを指定し，案件を生成して開始します。

引数

createAndStartProcessInstanceの引数を次の表に示します。

表5‒83　createAndStartProcessInstanceの引数

仮引数名

名称

in/out

説明

aAttributes

案件属性のマップ

in

案件属性（案件属性名と属性値の組）のマップを指定します。指定できる属性を次に示します。

案件名（Name）

処理期限（Deadline）

優先度（Priority）

案件属性を指定しない場合は，nullまたはサイズ0の案件属性のマップを指定します。各案件属性名の属性値は次に示す型で指定します。

案件名：java.lang.String型

処理期限：java.util.Date型

優先度：java.lang.Integer型

属性値にnullを指定した場合は，指定した案件属性は未設定になります。また，案件名の値は，空文字は指定できません。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。ただし，ミリ秒以下については切り捨てられます。

aProcessDefinitionName

ビジネスプロセス定義の名称

in

ビジネスプロセス定義の名称を指定します。

空文字列またはnullは指定できません。

aVersion

ビジネスプロセス定義のバージョン

in

ビジネスプロセス定義のバージョンを指定します。

nullを指定した場合，指定したビジネスプロセス定義の中で最新バージョンとなります。

戻り値

開始した案件オブジェクトを返します。

例外

createAndStartProcessInstanceで発生する例外を次の表に示します。

表5‒84　createAndStartProcessInstanceで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

処理期限を未設定とした場合でも，ビジネスプロセス定義の処理期限ルールを定義している場合，ビジネスプロセス定義の処理期限ルールに従い，案件開始時に案件の開始日時（START_DATE）を起算日として算出された値が設定されます。

案件名の値に空文字を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定された属性名と属性値の型が一致しない場合は，例外（java.lang.IllegalArgumentException）が発生します。

ビジネスプロセス定義の名称に空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

存在しないビジネスプロセス定義のバージョンを指定した場合は，例外（CIWEntityNotExistException）が発生します。

createProcessInstance

インタフェース名：CIWServer

構文

CIWProcessInstance createProcessInstance(
     java.util.Map
     <CIWProcessInstance.AttributeName,java.lang.Object> aAttributes,
     java.lang.String aProcessDefinitionName,
     java.lang.Short aVersion
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

案件属性，ビジネスプロセス定義の名称およびバージョンを指定して，案件を生成します。

引数

createProcessInstanceの引数を次の表に示します。

表5‒85　createProcessInstanceの引数

仮引数名

名称

in/out

説明

aAttributes

案件属性のマップ

in

案件属性（案件属性名と属性値の組）のマップを指定します。指定できる属性を次に示します。

案件名（Name）

処理期限（Deadline）

優先度（Priority）

案件属性を指定しない場合は，nullまたはサイズ0の案件属性のマップを指定します。各案件属性名の属性値は次に示す型で指定します。

案件名：java.lang.String型

処理期限：java.util.Date型

優先度：java.lang.Integer型

属性値にnullを指定した場合は，指定した案件属性は未設定になります。案件名の値は，空文字は指定できません。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。ただし，ミリ秒以下については切り捨てられます。

aProcessDefinitionName

ビジネスプロセス定義の名称

in

ビジネスプロセス定義の名称を指定します。

空文字列またはnullは指定できません。

aVersion

ビジネスプロセス定義のバージョン

in

ビジネスプロセス定義のバージョンを指定します。

nullを指定した場合，指定したビジネスプロセス定義の中で最新バージョンとなります。

戻り値

生成した案件オブジェクトを返します。

例外

createProcessInstanceで発生する例外を次の表に示します。

表5‒86　createProcessInstanceで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

ビジネスプロセス定義の処理期限ルールを定義している場合は，処理期限を未設定にしてもビジネスプロセス定義の処理期限ルールに従って値が設定されます。値は案件開始時に案件の開始日時（START_DATE）を起算日として算出されます。

案件名の値に空文字を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定された属性名と属性値の型が一致しない場合は，例外（java.lang.IllegalArgumentException）が発生します。

ビジネスプロセス定義の名称に空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

存在しないビジネスプロセス定義のバージョンを指定した場合は，例外（CIWEntityNotExistException）が発生します。

getActivityInstance

インタフェース名：CIWServer

構文

CIWActivityInstance getActivityInstance(
     java.lang.Integer aProcessInstanceID,
     java.lang.Integer aActivityInstanceID,
     java.util.Set<CIWActivityInstance.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

案件のIDと業務ステップのIDを指定して，業務ステップオブジェクトを取得します。

引数

getActivityInstanceの引数を次の表に示します。

表5‒87　getActivityInstanceの引数

仮引数名

名称

in/out

説明

aProcessInstanceID

案件のID

in

案件のIDを指定します。

nullは指定できません。

aActivityInstanceID

業務ステップのID

in

業務ステップのIDを指定します。

nullは指定できません。

aAttributeNames

業務ステップの属性名のセット

in

取得したい業務ステップの属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得可能な属性は，CIWActivityInstance.AttributeName列挙型で指定できる属性です。

戻り値

指定した案件のIDと業務ステップのIDを持つ業務ステップオブジェクトを返します。

例外

getActivityInstanceで発生する例外を次の表に示します。

表5‒88　getActivityInstanceで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

案件のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

業務ステップのIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定した条件を満たす業務ステップオブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。

取得属性名を何も指定していない場合は，指定した案件のIDおよび業務ステップのIDを設定しただけの業務ステップオブジェクトを生成して返します。

指定した案件のIDまたは業務ステップのIDが不正な場合は，業務ステップオブジェクトのメソッドを呼び出したときに，エラーになることがあります。

getActivityInstancesList

インタフェース名：CIWServer

構文

java.util.List<CIWActivityInstance> getActivityInstancesList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWActivityInstance.AttributeName> aAttributeNames
)
     throws CIWFatalException,
     CIWTransientException

機能

指定したフィルター条件を満たす業務ステップオブジェクトのリストを取得します。

引数

getActivityInstancesListの引数を次の表に示します。

表5‒89　getActivityInstancesListの引数

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

業務ステップを取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。 フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

業務ステップを取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

業務ステップを取得する場合のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

業務ステップを取得する場合の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい業務ステップの属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，業務ステップが所属する案件のIDと業務ステップのIDは必ず取得します。取得可能な属性は，CIWActivityInstance.AttributeName列挙型で指定できる属性です。

戻り値

取得した業務ステップオブジェクトのリストを返します。

例外

getActivityInstancesListで発生する例外を次の表に示します。

表5‒90　getActivityInstancesListで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす業務ステップオブジェクトが存在しない場合は，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，業務ステップの重複や漏れが発生することがあります。

getConnectionCoordinator

インタフェース名：CIWServer

構文

CIWConnectionCoordinator getConnectionCoordinator()
     throws CIWFatalExceptionCIWServer

機能

CIWServerオブジェクト内に保持されているコネクション関連づけオブジェクトを取得します。

引数

ありません。

戻り値

コネクション関連づけオブジェクトを返します。

例外

getConnectionCoordinatorで発生する例外を次の表に示します。

表5‒91　getConnectionCoordinatorで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

javax.sql.DataSourceを設定し，CIWServerオブジェクトを生成している場合に，このメソッドを呼び出すと例外（CIWFatalException）が発生します。

getListCount

インタフェース名：CIWServer

構文

int getListCount(
     CIWServer.Targetkind aTargetKind,
     java.lang.String aFilter
)
     throws CIWFatalException,
            CIWTransientException

機能

指定したフィルター条件を満たす各種オブジェクトのリスト件数を取得します。

引数

getListCountの引数を次の表に示します。

表5‒92　getListCountの引数

仮引数名

名称

in/out

説明

aTargetKind

対象

in

件数を取得する対象を指定します。

nullは指定できません。

aFilter

フィルター条件

in

件数を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。 フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

戻り値

フィルター条件と一致する件数を返します。

例外

getListCountで発生する例外を次の表に示します。

表5‒93　getListCountで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

取得する対象にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

getProcessDefinition

インタフェース名：CIWServer

構文

CIWProcessDefinition getProcessDefinition(
     java.lang.Integer aProcessDefinitionID,
     java.util.Set<CIWProcessDefinition.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

ビジネスプロセス定義のIDを指定して，ビジネスプロセス定義オブジェクトを取得します。

引数

getProcessDefinitionの引数を次の表に示します。

表5‒94　getProcessDefinitionの引数（CIWServerの場合）

仮引数名

名称

in/out

説明

aProcessDefinitionID

ビジネスプロセス定義のID

in

ビジネスプロセス定義のIDを指定します。

nullは指定できません。

aAttributeNames

属性名のセット

in

取得したいビジネスプロセス定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得可能な属性は，CIWProcessDefinition.AttributeName列挙型で指定できる属性です。

戻り値

指定したビジネスプロセス定義のIDを持つビジネスプロセス定義オブジェクトを返します。

例外

getProcessDefinitionで発生する例外を次の表に示します。

表5‒95　getProcessDefinitionで発生する例外（CIWServerの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

ビジネスプロセス定義のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定した条件を満たすビジネスプロセス定義オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。

取得属性名を何も指定していない場合は，指定したビジネスプロセス定義のIDを設定しただけのビジネスプロセス定義オブジェクトを生成して返します。

指定したビジネスプロセス定義のIDが不正な場合は，そのあとビジネスプロセス定義オブジェクトのメソッドを呼び出したときに，エラーとなることがあります。

getProcessDefinitionsList

インタフェース名：CIWServer

構文

java.util.List<CIWProcessDefinition> getProcessDefinitionsList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWProcessDefinition.AttributeName> aAttributeNames
)
     throws CIWFatalException,
     CIWTransientException

機能

指定したフィルター条件を満たすビジネスプロセス定義オブジェクトのリストを取得します。

引数

getProcessDefinitionsListの引数を次の表に示します。

表5‒96　getProcessDefinitionsListの引数

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

ビジネスプロセス定義を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

ビジネスプロセス定義を取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

ビジネスプロセス定義を取得する場合のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

ビジネスプロセス定義を取得する場合の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したいビジネスプロセス定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，ビジネスプロセス定義のIDは必ず取得します。取得可能な属性は，CIWProcessDefinition.AttributeName列挙型で指定できる属性です。

戻り値

取得したビジネスプロセス定義オブジェクトのリストを返します。

例外

getProcessDefinitionsListで発生する例外を次の表に示します。

表5‒97　getProcessDefinitionsListで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たすビジネスプロセス定義オブジェクトが存在しない場合は，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，ビジネスプロセス定義の重複や漏れが発生することがあります。

getProcessInstance

インタフェース名：CIWServer

構文

CIWProcessInstance getProcessInstance(
     java.lang.Integer aProcessInstanceID,
     java.util.Set<CIWProcessInstance.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

案件のIDを指定して，案件オブジェクトを取得します。

引数

getProcessInstanceの引数を次の表に示します。

表5‒98　getProcessInstanceの引数

仮引数名

名称

in/out

説明

aProcessInstanceID

案件のID

in

案件のIDを指定します。

nullは指定できません。

aAttributeNames

属性名のセット

in

取得したい案件の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得できる属性は，CIWProcessInstance.AttributeName列挙型で指定できる属性です。

戻り値

指定した案件のIDを持つ案件オブジェクトを返します。

例外

getProcessInstanceで発生する例外を次の表に示します。

表5‒99　getProcessInstanceで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

案件のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定した条件を満たす案件オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。

取得属性名を何も指定していない場合，指定した案件のIDを設定しただけの案件オブジェクトを生成して返します。

指定した案件のIDが 不正な場合は，案件オブジェクトのメソッドを呼び出したときに，エラーになることがあります。

getProcessInstancesList

インタフェース名：CIWServer

構文

java.util.List<CIWProcessInstance> getProcessInstancesList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWProcessInstance.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException

機能

指定したフィルター条件を満たす案件オブジェクトのリストを取得します。

引数

getProcessInstancesListの引数を次の表に示します。

表5‒100　getProcessInstancesListの引数（CIWServerの場合）

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

案件を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

案件を取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

案件を取得する場合のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

案件を取得する場合の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい案件の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，案件のIDは必ず取得します。取得可能な属性は，CIWProcessInstance.AttributeName列挙型で指定できる属性です。

戻り値

取得した案件のリストを返します。

例外

getProcessInstancesListで発生する例外を次の表に示します。

表5‒101　getProcessInstancesListで発生する例外（CIWServerの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす案件オブジェクトが存在しない場合は，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，案件の重複や漏れが発生することがあります。

getWorkDefinition

インタフェース名：CIWServer

構文

CIWWorkDefinition getWorkDefinition(
     java.lang.Integer aProcessDefinitionID,
     java.lang.Integer aWorkDefinitionID,
     java.util.Set<CIWWorkDefinition.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

ビジネスプロセス定義のIDおよび作業定義のIDを指定して，作業定義オブジェクトを取得します。

引数

getWorkDefinitionの引数を次の表に示します。

表5‒102　getWorkDefinitionの引数（CIWServerの場合）

仮引数名

名称

in/out

説明

aProcessDefinitionID

ビジネスプロセス定義のID

in

ビジネスプロセス定義のIDを指定します。

nullは指定できません。

aWorkDefinitionID

作業定義のID

in

作業定義のIDを指定します。

nullは指定できません。

aAttributeNames

属性名のセット

in

取得したい作業定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得できる属性は，CIWWorkDefinition.AttributeName列挙型で指定できる属性です。

戻り値

指定したビジネスプロセス定義のIDと作業定義のIDを持つ作業定義オブジェクトを返します。

例外

getWorkDefinitionで発生する例外を次の表に示します。

表5‒103　getWorkDefinitionで発生する例外（CIWServerの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

ビジネスプロセス定義のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

作業定義のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定した条件を満たす作業定義オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。

取得属性名を何も指定していない場合は，指定したビジネスプロセス定義のIDおよび作業定義のIDを設定しただけの作業定義オブジェクトを生成して返します。

指定したビジネスプロセス定義のIDまたは作業定義のIDが不正な場合は，作業定義オブジェクトのメソッドを呼び出したときに，エラーになることがあります。

getWorkDefinitionsList

インタフェース名：CIWServer

構文

java.util.List<CIWWorkDefinition> getWorkDefinitionsList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWWorkDefinition.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException

機能

指定したフィルター条件を満たす作業定義オブジェクトのリストを取得します。

引数

getWorkDefinitionsListの引数を次の表に示します。

表5‒104　getWorkDefinitionsListの引数

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

作業定義を取得する際のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。 フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

作業定義を取得する際のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

作業定義を取得する際のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

作業定義を取得する際の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい作業定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。 取得属性名に指定されていない場合でも，作業定義が所属するビジネスプロセス定義のIDと作業定義のIDは必ず取得します。取得可能な属性は，CIWWorkDefinition.AttributeName列挙型で指定できる属性です。

戻り値

取得した作業定義オブジェクトのリストを返します。

例外

getWorkDefinitionsListで発生する例外を次の表に示します。

表5‒105　getWorkDefinitionsListで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす作業定義オブジェクトが存在しない場合，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100のように指定して，複数回に分けて取得した場合，作業定義の重複や漏れが発生することがあります。

getWorkItem

インタフェース名：CIWServer

構文

CIWWorkItem getWorkItem(
     java.lang.Integer aProcessInstanceID,
     java.lang.Integer aWorkItemID,
     java.util.Set<CIWWorkItem.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

機能

案件のIDと作業のIDを指定して，作業オブジェクトを取得します。

引数

getWorkItemの引数を次の表に示します。

表5‒106　getWorkItemの引数

仮引数名

名称

in/out

説明

aProcessInstanceID

案件のID

in

案件のIDを指定します。

nullは指定できません。

aWorkItemID

作業のID

in

作業のIDを指定します。

nullは指定できません。

aAttributeNames

属性名のセット

in

取得したい作業の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得できる属性は，CIWWorkItem.AttributeName列挙型で指定できる属性です。

戻り値

指定した案件のIDと作業のIDを持つ作業オブジェクトを返します。

例外

getWorkItemで発生する例外を次の表に示します。

表5‒107　getWorkItemで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

案件のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

作業のIDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

指定した条件を満たす作業オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。

取得属性名を何も指定していない場合は，指定した案件のIDおよび作業のIDを設定しただけの作業オブジェクトを生成して返します。

指定した案件のIDまたは作業のIDが不正な場合は，案件オブジェクトのメソッドを呼び出したときに，エラーとなることがあります。

getWorkItemsList

インタフェース名：CIWServer

構文

java.util.List<CIWWorkItem> getWorkItemsList(
     java.lang.String aFilter,
     java.lang.String aSort,
     int aOffset,
     int aMaxCount,
     java.util.Set<CIWWorkItem.AttributeName> aAttributeNames
)
     throws CIWFatalException,
            CIWTransientException

機能

指定したフィルター条件を満たす作業オブジェクトのリストを取得します。

引数

getWorkItemsListの引数を次の表に示します。

表5‒108　getWorkItemsListの引数（CIWServerの場合）

仮引数名

名称

in/out

説明

aFilter

フィルター条件

in

作業を取得する場合のフィルター条件を指定します。

フィルター条件を指定しない場合は，nullを指定します。 フィルター条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aSort

ソート条件

in

作業を取得する場合のソート条件を指定します。

ソート条件を指定しない場合は，nullを指定します。 ソート条件の指定方法については，「付録B　参照系APIで指定できる属性」を参照してください。

aOffset

オフセット

in

作業を取得する場合のオフセットを指定します。

オフセットは先頭を0として指定します。0未満の値は指定できません。

aMaxCount

最大取得数

in

作業を取得する場合の最大取得数を指定します。

すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

aAttributeNames

属性名のセット

in

取得したい作業の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定していない場合でも，作業のIDと作業が所属する案件のIDは必ず取得します。取得できる属性は，CIWWorkItem.AttributeName列挙型で指定できる属性です。

戻り値

取得した作業オブジェクトのリストを返します。

例外

getWorkItemsListで発生する例外を次の表に示します。

表5‒109　getWorkItemsListで発生する例外（CIWServerの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransientException

一時的なエラーが発生した場合

注意事項

指定したフィルター条件を満たす作業オブジェクトが存在しない場合は，空のリストが返されます。

不正な引数を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

オフセットに0，50，100などを指定し，複数回に分けて取得した場合は，作業の重複や漏れが発生することがあります。

5.7　CIWWorkDefinition（作業定義のインタフェース）

作業定義のインタフェースです。

作業定義オブジェクトに対してメソッドを発行することで，対象となる作業定義オブジェクトに対して処理が行われます。

クラス定義

public interface CIWWorkDefinition

入れ子のクラス

CIWWorkDefinitionインタフェースの入れ子のクラスを次の表に示します。

表5‒110　CIWWorkDefinitionインタフェースの入れ子のクラス

クラス名

説明および記述形式

CIWWorkDefinition.AttributeName

作業定義属性の属性名の列挙型です。

static class CIWWorkDefinition.AttributeName

CIWWorkDefinition.Type

作業定義の種類の列挙型です。

static class CIWWorkDefinition.Type

メソッド

CIWWorkDefinitionインタフェースのメソッドを次の表に示します。

表5‒111　CIWWorkDefinitionインタフェースのメソッド

API名

説明

getActivityDefinitionID

対象となる作業定義が所属する業務ステップ定義のIDを取得します。

getCastingRuleName

対象となる作業定義の振り分けルール名を取得します。

getDescription

対象となる作業の説明を取得します。

getID

対象となる作業定義のIDを取得します。

getName

対象となる作業定義の名称を取得します。

getProcessDefinitionID

対象となる作業定義が所属するビジネスプロセス定義のIDを取得します。

getType

対象となる作業の種類を取得します。

getActivityDefinitionID

インタフェース名：CIWWorkDefinition

構文

java.lang.Integer getActivityDefinitionID()
     throws CIWFatalException

機能

対象となる作業定義が所属する業務ステップ定義のIDを取得します。

引数

ありません。

戻り値

作業定義が所属する業務ステップ定義のIDを返します。

例外

getActivityDefinitionIDで発生する例外を次の表に示します。

表5‒112　getActivityDefinitionIDで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作業定義が所属する業務ステップ定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getCastingRuleName

インタフェース名：CIWWorkDefinition

構文

java.lang.String getCastingRuleName()
     throws CIWFatalException

機能

対象となる作業定義の振り分けルール名を取得します。

引数

ありません。

戻り値

作業定義の振り分けルール名を返します。

例外

getCastingRuleNameで発生する例外を次の表に示します。

表5‒113　getCastingRuleNameで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に振り分けルール名の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getDescription

インタフェース名：CIWWorkDefinition

構文

java.lang.String getDescription()
     throws CIWFatalException

機能

対象となる作業の説明を取得します。

引数

ありません。

戻り値

作業の説明を返します。

例外

getDescriptionで発生する例外を次の表に示します。

表5‒114　getDescriptionで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に説明の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getID

インタフェース名：CIWWorkDefinition

構文

java.lang.Integer getID()
     throws CIWFatalException

機能

対象となる作業定義のIDを取得します。

引数

ありません。

戻り値

作業定義のIDを返します。

例外

getIDで発生する例外を次の表に示します。

表5‒115　getIDで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getName

インタフェース名：CIWWorkDefinition

構文

java.lang.String getName()
     throws CIWFatalException

機能

対象となる作業定義の名称を取得します。

引数

ありません。

戻り値

作業定義の名称を返します。

例外

getNameで発生する例外を次の表に示します。

表5‒116　getNameで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に名称の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessDefinitionID

インタフェース名：CIWWorkDefinition

構文

java.lang.Integer getProcessDefinitionID()
     throws CIWFatalException

機能

対象となる作業定義が所属するビジネスプロセス定義のIDを取得します。

引数

ありません。

戻り値

作業定義が所属するビジネスプロセス定義のIDを返します。

例外

getProcessDefinitionIDで発生する例外を次の表に示します。

表5‒117　getProcessDefinitionIDで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getType

インタフェース名：CIWWorkDefinition

構文

CIWWorkDefinition.Type getType()
     throws CIWFatalException

機能

対象となる作業の種類を取得します。

引数

ありません。

戻り値

作業の種類を返します。

例外

getTypeで発生する例外を次の表に示します。

表5‒118　getTypeで発生する例外（CIWWorkDefinitionの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に種類の取得を指定していない場合は，例外（CIWFatalException）が発生します。

5.8　CIWWorkItem（作業のインタフェース）

作業のインタフェースです。

作業オブジェクトに対してメソッドを発行することで，対象となる作業オブジェクトに対して処理が行われます。

クラス定義

public interface CIWWorkItem

入れ子のクラス

CIWWorkItemインタフェースの入れ子のクラスを次の表に示します。

表5‒119　CIWWorkItemインタフェースの入れ子のクラス

クラス名

説明および記述形式

CIWWorkItem.AttributeName

作業属性の属性名の列挙型です。

static class CIWWorkItem.AttributeName

CIWWorkItem.State

作業の状態の列挙型です。

static class CIWWorkItem.State

CIWWorkItem.Type

作業の種類の列挙型です。

static class CIWWorkItem.Type

メソッド

CIWWorkItemインタフェースのメソッドを次の表に示します。

表5‒120　CIWWorkItemインタフェースのメソッド

API名

説明

changeState

対象となる作業の状態を変更します。

complete

対象となる作業を「実行中」状態から「実行済」状態に変更したあと，対象となる作業が所属する業務ステップの終了評価を行います。

evaluate

対象となる作業の完了条件を評価します。

free

作業を返却して振り分けルールを再評価します。

getActivityInstanceID

対象となる作業が所属する業務ステップのIDを取得します。

getClosedDate

対象となる作業の終了日時を取得します。

getCreationDate

対象となる作業の発生日時を取得します。

getDeadline

対象となる作業の処理期限の絶対日時を取得します。

getID

対象となる作業のIDを取得します。

getName

対象となる作業の名称（作業キー）を取得します。

getParentProcessInstance

対象となる作業が所属する案件オブジェクトを取得します。

getParticipant

対象となる作業の作業者IDを取得します。

getPriority

対象となる作業の優先度を取得します。

getProcessDefinitionID

対象となる作業が所属するビジネスプロセス定義のIDを取得します。

getProcessInstanceID

対象となる作業が所属する案件のIDを取得します。

getProcessInstanceName

対象となる作業の案件名（案件キー）を取得します。

getStartDate

対象となる作業の開始日時を取得します。

getState

対象となる作業の状態を取得します。

getType

対象となる作業の種類を取得します。

getWorkDefinition

対象となる作業が所属する作業定義オブジェクトを取得します。

getWorkDefinitionID

対象となる作業定義のIDを取得します。

getWorkDefinitionName

対象となる作業定義の名称を取得します。

perform

対象となる作業を「実行開始可能」状態から「作業者実行」状態にします。

performAndComplete

対象となる作業を「実行開始可能」状態から「作業者実行」状態にし「実行済」状態に変更したあと，該当作業が所属する業務ステップの終了評価を行います。

reassign

対象となる作業の作業者を，指定した別の作業者に割り当てます。

reassignAndPerform

対象となる作業を別の作業者に割り当て，「実行開始可能」状態から「作業者実行」状態にします。

reevaluateCastingRule

対象となる作業の振り分けルールを再評価し，作業者を再割り当てします。

setDeadline

対象となる作業に対して，指定した日時を作業の処理期限の絶対日時として設定します。

setPriority

対象となる作業に対して，指定した優先度を設定します。

changeState

インタフェース名：CIWWorkItem

構文

void changeState(
     CIWWorkItem.State aNewState
)
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業の状態を変更します。

引数

changeStateの引数を次の表に示します。

表5‒121　changeStateの引数（CIWWorkItemの場合）

仮引数名

名称

in/out

説明

aNewState

状態

in

変更する作業の状態を指定します。

指定する値には，このインタフェースに定義されたCIWWorkItem.State列挙型の定数を指定できます。nullは指定できません。

aNewStateで指定できる作業の状態を次の表に示します。

表5‒122　aNewStateで指定できる作業の状態（CIWWorkItemの場合）

現在の状態

指定できる状態

状態遷移の意味

N

B

定数

意味

定数

意味

INITIAL

初期

READY

実行開始可能

準備済

○

○

READY

実行開始可能

PERFORMING

作業者実行

着手

○

×

PERFORMING

作業者実行

READY

実行開始可能

返却※1

○

×

PERFORMING

作業者実行

EXECUTED

実行済

完了通知

○

×

EXECUTING

自動実行

EXECUTED

実行済

作業完了

×

○

RUNNING

実行中

INTERMITTED

実行停止

中断

○

○

INTERMITTED

実行停止

RUNNING

実行中※2

再開※3

○

○

−

未終了

TERMINATED

強制終了

強制終了

○

○

（凡例）

N：一般作業に対する指定の可否

B：組み込み作業（並列作業）に対する指定の可否

定数：CIWWorkItem.State列挙型の定数

○：指定できることを示します。

×：指定できないことを示します。

−：定数がないことを表します。

注※1

アプリケーション自動起動を返却した場合は，アプリケーションを再起動します。

注※2

状態には，「実行中」，それに含まれる「自動実行」および「作業者実行」を指定できます。

注※3

指定できる状態のどれかを指定した場合は，次に示す状態に遷移します。

一般作業の場合：「作業者実行」

組み込み作業の場合：「自動実行」

状態遷移については，「付録C　状態遷移モデル」を参照してください。

戻り値

ありません。

例外

changeStateで発生する例外を次の表に示します。

表5‒123　changeStateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

対象となる作業が属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。

エラー回復作業で本メソッドを呼び出した場合は，例外（CIWStateException）が発生します。

変更する作業状態にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

作業を強制終了した場合は，対象となる作業が所属する業務ステップの完了条件の評価は行いません。そのため，対象となる作業が所属する業務ステップを直接完了させるか，またはCIWActivityInstance#evaluate()を使用して業務ステップの完了条件の評価を実行し，業務ステップの完了または作業の再作成を行う必要があります。CIWActivityInstance#evaluate()を使用して評価を実行する場合は，作業の発生条件や完了条件が適切に定義されている必要があります。

complete

インタフェース名：CIWWorkItem

構文

void complete()
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業を「実行中」状態から「実行済」状態に遷移させ，そのあと作業が所属する業務ステップの終了評価を行います。

引数

ありません。

戻り値

ありません。

例外

completeで発生する例外を次の表に示します。

表5‒124　completeで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

一般作業および組み込み作業で実行できます。エラー回復作業の場合は，エラーになります。

対象となる作業が所属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。

evaluate

インタフェース名：CIWWorkItem

構文

void evaluate()
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業の完了条件を評価します。評価の結果，作業が「完了」状態に遷移した場合は，CIWActivityInstanceインタフェースのevaluateメソッドと同様に，対象となる作業が所属する業務ステップの評価も行います。

引数

ありません。

戻り値

ありません。

例外

evaluateで発生する例外を次の表に示します。

表5‒125　evaluateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

作業は「実行開始可能」状態または「実行中」状態である必要があります。そのほかの場合では例外（CIWStateException）が発生します。

対象となる作業が所属する案件の状態は「実行中」状態または「実行停止」状態である必要があります。そのほかの状態では，例外（CIWStateException）が発生します。

free

インタフェース名：CIWWorkItem

構文

public void free(
)

機能

作業オブジェクトを「作業者実行」状態から「実行開始可能」状態に変更したあと，振り分けルールを再評価して作業者を決定し直します。

引数

ありません。

戻り値

ありません。

例外

freeで発生する例外を次の表に示します。

表5‒126　freeで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

CIWServerクラスのメソッドallocateWorkItemExで取得したCIWWorkItem（作業）に対して，このメソッドを発行してください。

作業生成後に振り分けルールで評価するユーザデータを変更すると，作業生成時に振り分けルールで決定した作業者と，このメソッドの発行時に振り分けルール再評価で決定した作業者が異なる場合があります。

getActivityInstanceID

インタフェース名：CIWWorkItem

構文

java.lang.Integer getActivityInstanceID()
     throws CIWFatalException

機能

対象となる作業が所属する業務ステップのIDを取得します。

引数

ありません。

戻り値

作業が所属する業務ステップのIDを返します。

例外

getActivityInstanceIDで発生する例外を次の表に示します。

表5‒127　getActivityInstanceIDで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作業が所属する業務ステップのIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getClosedDate

インタフェース名：CIWWorkItem

構文

java.util.Date getClosedDate()
     throws CIWFatalException

機能

対象となる作業の終了日時を取得します。

引数

ありません。

戻り値

作業の終了日時を返します。

例外

getClosedDateで発生する例外を次の表に示します。

表5‒128　getClosedDateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

「終了」状態への遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に終了日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getCreationDate

インタフェース名：CIWWorkItem

構文

java.util.Date getCreationDate()
     throws CIWFatalException

機能

対象となる作業の発生日時を取得します。

引数

ありません。

戻り値

作業の発生日時を返します。

例外

getCreationDateで発生する例外を次の表に示します。

表5‒129　getCreationDateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

「実行開始可能」状態への遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に発生日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getDeadline

インタフェース名：CIWWorkItem

構文

java.util.Date getDeadline()
     throws CIWFatalException

機能

対象となる作業の処理期限の絶対日時を取得します。

引数

ありません。

戻り値

作業の処理期限の絶対日時を返します。

例外

getDeadlineで発生する例外を次の表に示します。

表5‒130　getDeadlineで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に処理期限の絶対日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getID

インタフェース名：CIWWorkItem

構文

java.lang.Integer getID()
     throws CIWFatalException

機能

対象となる作業のIDを取得します。

引数

ありません。

戻り値

作業のIDを返します。

例外

getIDで発生する例外を次の表に示します。

表5‒131　getIDで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getName

インタフェース名：CIWWorkItem

構文

java.lang.String getName()
     throws CIWFatalException

機能

対象となる作業の名称（作業キー）を取得します。

引数

ありません。

戻り値

作業の名称（作業キー）を返します。

例外

getNameで発生する例外を次の表に示します。

表5‒132　getNameで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に名称（作業キー）の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getParentProcessInstance

インタフェース名：CIWWorkItem

構文

CIWProcessInstance getParentProcessInstance(
     java.util.Set<CIWProcessInstance.AttributeName> aAttributeNames
)
     throws CIWTransientException,
     CIWFatalException,
     CIWEntityNotExistException

機能

対象となる作業が所属する案件オブジェクトを取得します。

引数

getParentProcessInstanceの引数を次の表に示します。

表5‒133　getParentProcessInstanceの引数

仮引数名

名称

in/out

説明

aAttributeNames

属性名のセット

in

取得したい案件の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，案件のIDは必ず取得します。取得できる属性は，CIWProcessInstance.AttributeName列挙型で指定できる属性です。

戻り値

作業が所属する案件オブジェクトを返します。

例外

getParentProcessInstanceで発生する例外を次の表に示します。

表5‒134　getParentProcessInstanceで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できないような障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

getParticipant

インタフェース名：CIWWorkItem

構文

java.lang.String getParticipant()
     throws CIWFatalException

機能

対象となる作業の作業者IDを取得します。

引数

ありません。

戻り値

作業の作業者IDを返します。

例外

getParticipantで発生する例外を次の表に示します。

表5‒135　getParticipantで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に作業者IDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getPriority

インタフェース名：CIWWorkItem

構文

java.lang.Integer getPriority()
     throws CIWFatalException

機能

対象となる作業の優先度を取得します。

引数

ありません。

戻り値

作業の優先度を返します。

例外

getPriorityで発生する例外を次の表に示します。

表5‒136　getPriorityで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に優先度の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessDefinitionID

インタフェース名：CIWWorkItem

構文

java.lang.Integer getProcessDefinitionID()
     throws CIWFatalException

機能

対象となる作業が所属するビジネスプロセス定義のIDを取得します。

引数

ありません。

戻り値

作業が所属するビジネスプロセス定義のIDを返します。

例外

getProcessDefinitionIDで発生する例外を次の表に示します。

表5‒137　getProcessDefinitionIDで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作業が所属するビジネスプロセス定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getProcessInstanceID

インタフェース名：CIWWorkItem

構文

java.lang.Integer getProcessInstanceID()
     throws CIWFatalException

機能

対象となる作業が所属する案件のIDを取得します。

引数

ありません。

戻り値

作業が所属する案件のIDを返します。

例外

getProcessInstanceIDで発生する例外を次の表に示します。

表5‒138　getProcessInstanceIDで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

getProcessInstanceName

インタフェース名：CIWWorkItem

構文

java.lang.String getProcessInstanceName()
     throws CIWFatalException

機能

対象となる作業の案件名（案件キー）を取得します。

引数

ありません。

戻り値

作業の案件名（案件キー）を返します。

例外

getProcessInstanceNameで発生する例外を次の表に示します。

表5‒139　getProcessInstanceNameで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

未設定時にはnullが返されます。

オブジェクト取得時に案件名（案件キー）の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getStartDate

インタフェース名：CIWWorkItem

構文

java.util.Date getStartDate()
     throws CIWFatalException

機能

対象となる作業の開始日時を取得します。

引数

ありません。

戻り値

作業の開始日時を返します。

例外

getStartDateで発生する例外を次の表に示します。

表5‒140　getStartDateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

「実行中」状態に含まれる「作業者実行」状態，または「自動実行」状態に遷移が発生した場合に値が設定されます。

遷移の発生前はnullが返されます。状態遷移については，「付録C　状態遷移モデル」を参照してください。

オブジェクト取得時に開始日時の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getState

インタフェース名：CIWWorkItem

構文

CIWWorkItem.State getState()
     throws CIWFatalException

機能

対象となる作業の状態を取得します。

引数

ありません。

戻り値

作業の状態を返します。

例外

getStateで発生する例外を次の表に示します。

表5‒141　getStateで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に状態の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getType

インタフェース名：CIWWorkItem

構文

CIWWorkItem.Type getType()
     throws CIWFatalException

機能

対象となる作業の種類を取得します。

引数

ありません。

戻り値

作業の種類を返します。

例外

getTypeで発生する例外を次の表に示します。

表5‒142　getTypeで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に種類の取得を指定していない場合は，例外（CIWFatalException）が発生します。

getWorkDefinition

インタフェース名：CIWWorkItem

構文

CIWWorkDefinition getWorkDefinition(
     java.util.Set<CIWWorkDefinition.AttributeName> aAttributeNames
)
     throws CIWTransientException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる作業が所属する作業定義オブジェクトを取得します。

引数

getWorkDefinitionの引数を次の表に示します。

表5‒143　getWorkDefinitionの引数（CIWWorkItemの場合）

仮引数名

名称

in/out

説明

aAttributeNames

属性名のセット

in

取得したい作業定義の属性名のセットを指定します。

取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定されていない場合でも，作業が所属するビジネスプロセス定義のIDと作業定義のIDは必ず取得します。取得できる属性は，CIWWorkDefinition.AttributeName列挙型で指定できる属性です。

戻り値

作業が所属する作業定義オブジェクトを返します。

例外

getWorkDefinitionで発生する例外を次の表に示します。

表5‒144　getWorkDefinitionで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

オブジェクト取得時に作業が所属するビジネスプロセス定義のIDと作業定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getWorkDefinitionID

インタフェース名：CIWWorkItem

構文

java.lang.Integer getWorkDefinitionID()
     throws CIWFatalException

機能

対象となる作業定義のIDを取得します。

引数

ありません。

戻り値

作業定義のIDを返します。

例外

getWorkDefinitionIDで発生する例外を次の表に示します。

表5‒145　getWorkDefinitionIDで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

アドホック生成された作業またはエラー回復作業の場合はnullが返されます。

オブジェクト取得時に作業定義のIDの取得を指定していない場合は，例外（CIWFatalException）が発生します。

getWorkDefinitionName

インタフェース名：CIWWorkItem

構文

java.lang.String getWorkDefinitionName()
     throws CIWFatalException

機能

対象となる作業定義の名称を取得します。

引数

ありません。

戻り値

作業定義の名称を返します。

例外

getWorkDefinitionNameで発生する例外を次の表に示します。

表5‒146　getWorkDefinitionNameで発生する例外

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

オブジェクト取得時に作業定義の名称の取得を指定していない場合は，例外（CIWFatalException）が発生します。

perform

インタフェース名：CIWWorkItem

構文

void perform()
     throws CIWTransientException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業を「実行開始可能」状態から「作業者実行」状態にします。

引数

ありません。

戻り値

ありません。

例外

performで発生する例外を次の表に示します。

表5‒147　performで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

一般作業およびエラー回復作業で実行できます。

組み込み作業の場合はエラーになります。

performAndComplete

インタフェース名：CIWWorkItem

構文

void performAndComplete()
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業を「実行開始可能」状態から「作業者実行」状態へ遷移させて「実行済」状態に変更し，そのあと作業が所属する業務ステップの終了評価を行います。

performメソッドとcompleteメソッドを連続して実行する場合と同様に処理を行います。

引数

ありません。

戻り値

ありません。

例外

performAndCompleteで発生する例外を次の表に示します。

表5‒148　performAndCompleteで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

一般作業で実行可能です。エラー回復作業または組み込み作業の場合はエラーとなります。

対象となる作業が所属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。

reassign

インタフェース名：CIWWorkItem

構文

void reassign(
     java.lang.String aSource,
     java.lang.String aTarget
)
     throws CIWTransientException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業の作業者を，指定した別の作業者に割り当てます。

引数

reassignの引数を次の表に示します。

表5‒149　reassignの引数

仮引数名

名称

in/out

説明

aSource

変更する前の作業者ID

in

変更する前の作業者IDを指定します。

未設定の場合は，nullを指定します。空文字列は指定できません。

aTarget

新しい作業者ID

in

新しい作業者IDを<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数以下で指定します。

nullを指定した場合，新しい作業者IDは未設定となります。空文字列は指定できません。

戻り値

ありません。

例外

reassignで発生する例外を次の表に示します。

表5‒150　reassignで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

作業が「未終了」状態の場合だけ変更できます。

一般作業およびエラー回復作業で実行できます。

組み込み作業の場合は，例外（CIWStateException）が発生します。

引数aSourceに指定した作業者IDと対象となる作業の作業者IDが異なる場合は，例外（CIWStateException）が発生します。

作業者IDに空文字列を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

作業者IDに<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数を超える文字列を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

reassignAndPerform

インタフェース名：CIWWorkItem

構文

void reassignAndPerform(
     java.lang.String aSource,
     java.lang.String aTarget
)
     throws CIWTransientException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

機能

対象となる作業を別の作業者に割り当て，「実行開始可能」状態から「作業者実行」状態へ遷移させます。

reassignメソッドとperformメソッドを連続して実行する場合と同様に処理を行います。

引数

reassignAndPerformの引数を次の表に示します。

表5‒151　reassignAndPerformの引数

仮引数名

名称

in/out

説明

aSource

変更する前の作業者ID

in

変更する前の作業者IDを指定します。

未設定の場合は，nullを指定します。空文字列は指定できません。

aTarget

新しい作業者ID

in

新しい作業者IDを<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数以下で指定します。

nullを指定した場合，新しい作業者IDは未設定になります。空文字列は指定できません。

戻り値

ありません。

例外

reassignAndPerformで発生する例外を次の表に示します。

表5‒152　reassignAndPerformで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWStateException

状態の遷移に失敗した場合

注意事項

対象となる作業は，「実行開始可能」状態である必要があります。

一般作業およびエラー回復作業の場合だけ実行できます。

組み込み作業の場合は，例外（CIWStateException）が発生します。

対象となる作業が「作業者実行」状態の場合は，例外（CIWStateException）が発生します。

対象となる作業の状態が「実行開始可能」状態，または「作業者実行」状態でない場合は，例外（CIWStateException）が発生します。

引数aSourceに指定した作業者IDと対象となる作業の作業者IDが異なる場合は，例外（CIWStateException）が発生します。

作業者IDに空文字を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

作業者IDに<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数を超える文字列を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

reevaluateCastingRule

インタフェース名：CIWWorkItem

構文

void reevaluateCastingRule()
     throws CIWTransientException,
            CIWEntityNotExistException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWStateException

機能

対象となる作業の振り分けルールを再評価し，作業者を再割り当てします。

引数

ありません。

戻り値

ありません。

例外

reevaluateCastingRuleで発生する例外を次の表に示します。

表5‒153　reevaluateCastingRuleで発生する例外

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

CIWTransitionFailedException

案件処理中にエラーが発生した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWStateException

状態の遷移に失敗した場合

注意事項

対象となる作業は，「初期」状態以外の「未終了」状態である必要があります。

そのほかの状態の場合は，例外（CIWStateException）が発生します。

組み込み作業およびエラー回復作業でこのメソッドを呼び出した場合は，例外（CIWStateException）が発生します。

振り分けルールが設定されていない一般作業は作業者を変更しません。

振り分けルール評価の結果，作業者候補が1人も見つからなかった場合は，例外（CIWTransitionFailedException）が発生します。

対象となる作業が所属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。

setDeadline

インタフェース名：CIWWorkItem

構文

void setDeadline(
     java.util.Date aNewDeadline
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる作業に対して，指定した日時を作業の処理期限の絶対日時として設定します。

引数

setDeadlineの引数を次の表に示します。

表5‒154　setDeadlineの引数（CIWWorkItemの場合）

仮引数名

名称

in/out

説明

aNewDeadline

変更後の処理期限

in

変更後の処理期限を指定します。

nullを指定した場合は，処理期限は未設定となります。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。処理期限はミリ秒以下については切り捨てて設定します。

戻り値

ありません。

例外

setDeadlineで発生する例外を次の表に示します。

表5‒155　setDeadlineで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

作業が「未終了」状態の場合だけ変更できます。

作業が「未終了」状態以外の場合は，例外（CIWStateException）が発生します。

setPriority

インタフェース名：CIWWorkItem

構文

void setPriority(
     java.lang.Integer aNewPriority
)
     throws CIWTransientException,
            CIWStateException,
            CIWFatalException,
            CIWEntityNotExistException

機能

対象となる作業に対して，指定した優先度を設定します。

引数

setPriorityの引数を次の表に示します。

表5‒156　setPriorityの引数（CIWWorkItemの場合）

仮引数名

名称

in/out

説明

aNewPriority

変更後の優先度

in

変更後の優先度を指定します。

nullを指定した場合は，優先度は未設定となります。

戻り値

ありません。

例外

setPriorityで発生する例外を次の表に示します。

表5‒157　setPriorityで発生する例外（CIWWorkItemの場合）

発生する例外

説明

CIWTransientException

一時的なエラーが発生した場合

CIWStateException

状態の遷移に失敗した場合

CIWFatalException

処理を続行できない障害が発生した場合

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合

注意事項

作業が「未終了」状態の場合だけ変更できます。

作業が「未終了」状態以外の場合は，例外（CIWStateException）が発生します。

6　その他のクラス

この章では，その他のAPIについて説明します。

6.1　記述形式

6.1.1　その他のクラスの記述形式

その他のクラスは，次に示す形式を基本として説明しています。

クラス定義

クラス定義を示します。

入れ子のクラス

入れ子のクラスを説明します。

メソッド

クラスのメソッドを説明します。

6.1.2　その他のクラスが提供するメソッドの記述形式

その他のクラスが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名

メソッドが所属するクラス名を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

6.2　CIWConnectionCoordinator（CIWServerとJDBCコネクションの関連づけを管理するクラス）

JDBCコネクションとCIWServerオブジェクトの関連づけをするクラスです。

クラス定義

public final class CIWConnectionCoordinator extends java.lang.Object

メソッド

CIWConnectionCoordinatorクラスのメソッドを次の表に示します。

表6‒1　CIWConnectionCoordinatorクラスのメソッド

メソッド

説明

attachDatabaseConnection

トランザクションを開始しているJDBCコネクションをCIWServerオブジェクトに関連づけます。

detachDatabaseConnection

JDBCコネクションとCIWServerオブジェクトとの関連づけを解除します。

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，toString，wait，wait，wait

attachDatabaseConnection

クラス名：CIWConnectionCoordinator

構文

public void attachDatabaseConnection(
     java.sql.Connection aDBConnection
)
     throws CIWFatalException,
            CIWSQLTransientException

機能

トランザクションを開始しているJDBCコネクションをCIWServerオブジェクトに関連づけます。

引数

attachDatabaseConnectionの引数を次の表に示します。

表6‒2　attachDatabaseConnectionの引数

仮引数名

名称

in/out

説明

aDBConnection

JDBCコネクション

in

CIWServerオブジェクトに関連づけるJDBCコネクションを指定します。

nullは指定できません。

戻り値

ありません。

例外

attachDatabaseConnectionで発生する例外を次の表に示します。

表6‒3　attachDatabaseConnectionで発生する例外

クラス名

説明

CIWFatalException

処理を続行できない障害が発生した場合

CIWSQLTransientException

DBアクセスで一時的エラーが発生した場合

注意事項

次に示す場合は，例外（CIWFatalException）が発生します。

引数に渡すJDBCコネクションにnullを指定した場合

空文字列引数に渡すJDBCコネクションの自動コミットモードが有効になっている場合

このメソッドを実行する前にCIWServerオブジェクトのAPIを発行した場合

このメソッドを実行したあとは，関連づけを解除するまでJDBCコネクションを切断したり，トランザクションを終了したりしないでください。

detachDatabaseConnection

クラス名：CIWConnectionCoordinator

構文

public void detachDatabaseConnection()

機能

JDBCコネクションとCIWServerオブジェクトとの関連づけを解除します。

すでに関連づけを解除していた場合は何もしません。

引数

ありません。

戻り値

ありません。

例外

ありません。

注意事項

トランザクションを終了する前に，このメソッドを実行し，JDBCコネクションの関連づけを解除してください。このメソッドを実行しなかった場合の動作は保証しません。

6.3　CIWUtil（各種ユーティリティ機能を提供するクラス）

各種ユーティリティ機能を提供するクラスです。

クラス定義

public final class CIWUtil extends java.lang.Object

入れ子のクラス

CIWUtilの入れ子のクラスを次の表に示します。

表6‒4　CIWUtilの入れ子のクラス

クラス名

説明

CIWUtil.InfinityDate

無限遠の日付の列挙型です。

メソッド

CIWUtilクラスのメソッドを次の表に示します。

表6‒5　CIWUtilクラスのメソッド

メソッド

説明

convertDateToString

引数で渡されたCIWUtil.InfinityDate列挙型の定数を，フィルター条件の指定用java.lang.String型の文字列へ変換します。

convertDateToString

引数で渡されたDate型の日付情報を，フィルター条件の指定用java.lang.String型の文字列へ変換します。

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，toString，wait，wait，wait

convertDateToString

クラス名：CIWUtil

構文

public static java.lang.String convertDateToString(
     CIWUtil.InfinityDate aInfinityDate
)

機能

引数で渡されたCIWUtil.InfinityDate列挙型の定数を，フィルター条件の指定用java.lang.String型の文字列に変換します。

引数

convertDateToStringの引数を次の表に示します。

表6‒6　convertDateToStringの引数

仮引数名

名称

in/out

説明

aInfinityDate

CIWUtil.InfinityDate列挙型の定数

in

CIWUtil.InfinityDate列挙型の定数を指定します。

nullは指定できません。

戻り値

フィルター条件指定用の文字列を返します。

例外

ありません。

注意事項

列挙型の定数にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

convertDateToString

クラス名：CIWUtil

構文

public static java.lang.String convertDateToString(
     java.util.Date aDate
)

機能

引数で渡されたDate型の日付情報を，フィルター条件の指定用java.lang.String型の文字列に変換します。

引数

convertDateToStringの引数を次の表に示します。

表6‒7　convertDateToStringの引数

仮引数名

名称

in/out

説明

aDate

Date型の日付情報

in

Date型の日付情報を指定します。

nullは指定できません。

戻り値

フィルター条件指定用の文字列を返します。

例外

ありません。

注意事項

無限遠の過去および無限遠の未来を表すDate型オブジェクトを指定することもできます。無限遠の過去および無限遠の未来については，CIWUtil.InfinityDateを参照してください。

指定した日付が1970/01/02 00:00:00 GMTから292278993/12/31 00:00:00 GMTの範囲外であった場合は，例外（java.lang.IllegalArgumentException）が発生します。

日付情報にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。

7　列挙型

この章では，パッケージ「jp.co.Hitachi.soft.csciw」が提供する列挙型について説明します。

7.1　記述形式

7.1.1　列挙型の記述形式

列挙型は，次に示す形式を基本として説明しています。

概要

列挙型の概要を説明します。

定義

列挙型の定義を示します。

すべての実装されたインタフェース

列挙型のすべての実装されたインタフェースを示します。

含まれているインタフェース

列挙型の含まれているインタフェースを示します。

定数

列挙型の定数を説明します。

メソッド

列挙型のメソッドを説明します。

7.1.2　列挙型が提供するメソッドの記述形式

列挙型が提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

列挙型

メソッドが所属する列挙型を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

オーバーライド

メソッドのオーバーライドを示します。

戻り値

メソッドが返す戻り値を示します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

7.2　CIWActivityInstance.AttributeName（業務ステップ属性の属性名の列挙型）

概要

業務ステップ属性の属性名の列挙型です。

定義

public static enum CIWActivityInstance.AttributeName
     extends java.lang.Enum<CIWActivityInstance.AttributeName>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWActivityInstance.AttributeName>

含まれているインタフェース

CIWActivityInstance

定数

CIWActivityInstance.AttributeNameの列挙型定数を次の表に示します。

表7‒1　CIWActivityInstance.AttributeNameの列挙型定数

定数名

説明および記述形式

ACTIVITY_DEFINITION_ID

「業務ステップ定義のID」を表す定数です。

public static final CIWActivityInstance.AttributeName ACTIVITY_DEFINITION_ID

ACTIVITY_DEFINITION_NAME

「業務ステップ定義の名称」を表す定数です。

public static final CIWActivityInstance.AttributeName ACTIVITY_DEFINITION_NAME

CLOSED_DATE

「業務ステップの終了日時」を表す定数です。

public static final CIWActivityInstance.AttributeName CLOSED_DATE

DEADLINE

「業務ステップの処理期限の絶対日時」を表す定数です。

業務ステップ開始時に，業務ステップ定義の処理期限ルールに従って案件の開始日時（START_DATE）を起算日として算出された値が設定されます。ただし，すでにAPIによって明示的に値を設定している場合は，処理期限ルールは適用されません。

未設定時は，nullが設定されています。

public static final CIWActivityInstance.AttributeName DEADLINE

ID

「業務ステップのID」を表す定数です。

public static final CIWActivityInstance.AttributeName ID

NAME

「業務ステップの名称（業務ステップキー）」を表す定数です。

public static final CIWActivityInstance.AttributeName NAME

PRIORITY

「業務ステップの優先度」を表す定数です。

public static final CIWActivityInstance.AttributeName PRIORITY

PROCESS_DEFINITION_ID

「業務ステップが所属するビジネスプロセス定義のID」を表す定数です。

public static final CIWActivityInstance.AttributeName PROCESS_DEFINITION_ID

PROCESS_INSTANCE_ID

「業務ステップが所属する案件のID」を表す定数です。

public static final CIWActivityInstance.AttributeName PROCESS_INSTANCE_ID

PROCESS_INSTANCE_NAME

「案件名（案件キー）」を表す定数です。

public static final CIWActivityInstance.AttributeName PROCESS_INSTANCE_NAME

START_DATE

「業務ステップの開始日時」を表す定数です。

public static final CIWActivityInstance.AttributeName START_DATE

STATE

「業務ステップの状態」を表す定数です。

public static final CIWActivityInstance.AttributeName STATE

TYPE

「業務ステップの種類」を表す定数です。

public static final CIWActivityInstance.AttributeName TYPE

メソッド

CIWActivityInstance.AttributeNameのメソッドを次の表に示します。

表7‒2　CIWActivityInstance.AttributeNameのメソッド

メソッド

説明

toAttributeName

業務ステップ属性の属性名（属性を格納するテーブルのカラム名）を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toAttributeName

列挙型：CIWActivityInstance.AttributeName

構文

public final java.lang.String
     toAttributeName()

機能

業務ステップ属性の属性名（属性を格納するテーブルのカラム名）を取得します。

引数

ありません。

戻り値

業務ステップ属性の属性名を返します。

例外

ありません。

valueOf

列挙型：CIWActivityInstance.AttributeName

構文

public static CIWActivityInstance.AttributeName valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒3　valueOfの引数（CIWActivityInstance.AttributeNameの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒4　valueOfで発生する例外（CIWActivityInstance.AttributeNameの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWActivityInstance.AttributeName

構文

public static final CIWActivityInstance.AttributeName[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWActivityInstance.AttributeName c : CIWActivityInstance.AttributeName.values())
ｆ

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.3　CIWActivityInstance.State（業務ステップの状態の列挙型）

概要

業務ステップの状態の列挙型です。

定義

public static enum CIWActivityInstance.State
     extends java.lang.Enum<CIWActivityInstance.State>

すべての実装されたインタフェース

java.io.Serializable，java.lang.Comparable<CIWActivityInstance.State>

含まれているインタフェース

CIWActivityInstance

定数

CIWActivityInstance.Stateの列挙型定数を次の表に示します。

表7‒5　CIWActivityInstance.Stateの列挙型定数

定数名

説明および記述形式

ABORTED※

「異常終了」を表す定数です。

短縮表記形式：aborted

完全表記形式：closed.aborted

コード値：v

public static final CIWActivityInstance.State ABORTED

DISABLED

「実行開始不可」を表す定数です。

短縮表記形式：disabled

完全表記形式：open.notRunning.suspended.disabled

コード値：l

public static final CIWActivityInstance.State DISABLED

INITIAL

「初期」を表す定数です。

短縮表記形式：initial

完全表記形式：open.notRunning.notStarted.initial

コード値：i

public static final CIWActivityInstance.State INITIAL

INTERMITTED

「実行停止」を表す定数です。

短縮表記形式：intermitted

完全表記形式：open.notRunning.suspended.intermitted

コード値：m

public static final CIWActivityInstance.State INTERMITTED

NOT_EXECUTED

「実行省略」を表す定数です。

短縮表記形式：notExecuted

完全表記形式：closed.completed.notExecuted

コード値：p

public static final CIWActivityInstance.State NOT_EXECUTED

READY

「実行開始可能」を表す定数です。

短縮表記形式：ready

完全表記形式：open.notRunning.notStarted.ready

コード値：j

public static final CIWActivityInstance.State READY

READY_FOR_TRANSITION

「遷移可」を表す定数です。

短縮表記形式：readyForTransition

完全表記形式：closed.completed.executed.readyForTransition

コード値：s

public static final CIWActivityInstance.State READY_FOR_TRANSITION

RUNNING

「実行中」を表す定数です。

短縮表記形式：running

完全表記形式：open.running

コード値：d

public static final CIWActivityInstance.State RUNNING

TERMINATED

「強制終了」を表す定数です。

短縮表記形式：terminated

完全表記形式：closed.terminated

コード値：u

public static final CIWActivityInstance.State TERMINATED

TRANSITION_COMPLETED

「遷移済」を表す定数です。

短縮表記形式：transitionCompleted

完全表記形式：closed.completed.executed.transitionCompleted

コード値：t

public static final CIWActivityInstance.State TRANSITION_COMPLETED

UNDEFINED

「未定義」を表す定数です。

短縮表記形式：undefined

完全表記形式：undefined

コード値：z

public static final CIWActivityInstance.State UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWActivityInstance.Stateのメソッドを次の表に示します。

表7‒6　CIWActivityInstance.Stateのメソッド

メソッド

説明

fromStateCode

指定したStateのコード値に対応した業務ステップの状態を定数に持つ，State列挙型を返します。

isClosed

業務ステップが「終了」状態かどうかを判定します。

isCompleted

業務ステップが「完了」状態かどうかを判定します。

isExecuted

業務ステップが「実行済」状態かどうかを判定します。

isNotRunning

業務ステップが「停止中」状態かどうかを判定します。

isNotStarted

業務ステップが「未実行」状態かどうかを判定します。

isOpen

業務ステップが「未終了」状態かどうかを判定します。

isSuspended

業務ステップが「中断」状態かどうかを判定します。

toShortState

業務ステップの状態を示すStateの短縮表記形式を取得します。

toState

業務ステップの状態を示すStateの完全表記形式を取得します。

toStateCode

業務ステップの状態を示すStateのコード値を取得します。

toString

業務ステップの状態を示す文字列表現を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromStateCode

列挙型：CIWActivityInstance.State

構文

public static CIWActivityInstance.State fromStateCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したStateのコード値に対応した業務ステップの状態を定数に持つ，State列挙型を返します。

引数

fromStateCodeの引数を次の表に示します。

表7‒7　fromStateCodeの引数（CIWActivityInstance.Stateの場合）

仮引数名

名称

in/out

説明

aCode

State列挙型のStateCodeの値

in

取得したいState列挙型のStateCodeの値を指定します。

戻り値

Stateのコード値に対応する状態を定数に持つState列挙型を返します。

例外

fromStateCodeで発生する例外を次の表に示します。

表7‒8　fromStateCodeで発生する例外（CIWActivityInstance.Stateの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Stateのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

isClosed

列挙型：CIWActivityInstance.State

構文

public boolean isClosed()

機能

業務ステップが「終了」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「終了」状態の場合はtrueを返します。

業務ステップが「終了」状態以外の場合はfalseを返します。

例外

ありません。

isCompleted

列挙型：CIWActivityInstance.State

構文

public boolean isCompleted()

機能

業務ステップが「完了」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「完了」状態の場合はtrueを返します。

業務ステップが「完了」状態以外の場合はfalseを返します。

例外

ありません。

isExecuted

列挙型：CIWActivityInstance.State

構文

public boolean isExecuted()

機能

業務ステップが「実行済」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「実行済」状態の場合はtrueを返します。

業務ステップが「実行済」状態以外の場合はfalseを返します。

例外

ありません。

isNotRunning

列挙型：CIWActivityInstance.State

構文

public boolean isNotRunning()

機能

業務ステップが「停止中」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「停止中」状態の場合はtrueを返します。

業務ステップが「停止中」状態以外の場合はfalseを返します。

例外

ありません。

isNotStarted

列挙型：CIWActivityInstance.State

構文

public boolean isNotStarted()

機能

業務ステップが「未実行」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「未実行」状態の場合はtrueを返します。

業務ステップが「未実行」状態以外の場合はfalseを返します。

例外

ありません。

isOpen

列挙型：CIWActivityInstance.State

構文

public boolean isOpen()

機能

業務ステップが「未終了」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「未終了」状態の場合はtrueを返します。

業務ステップが「未終了」状態以外の場合はfalseを返します。

例外

ありません。

isSuspended

列挙型：CIWActivityInstance.State

構文

public boolean isSuspended()

機能

業務ステップが「中断」状態かどうかを判定します。

引数

ありません。

戻り値

業務ステップが「中断」状態の場合はtrueを返します。

業務ステップが「中断」状態以外の場合はfalseを返します。

例外

ありません。

toShortState

列挙型：CIWActivityInstance.State

構文

public final java.lang.String toShortState()

機能

業務ステップの状態を示すStateの短縮表記形式を取得します。

引数

ありません。

戻り値

Stateの短縮表記形式を返します。

例外

ありません。

toState

列挙型：CIWActivityInstance.State

構文

public final java.lang.String toState()

機能

業務ステップの状態を示すStateの完全表記形式を取得します。

引数

ありません。

戻り値

Stateの完全表記形式を返します。

例外

ありません。

注意事項

Stateの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toStateCode

列挙型：CIWActivityInstance.State

構文

public final java.lang.String toStateCode()

機能

業務ステップの状態を示すStateのコード値を取得します。

引数

ありません。

戻り値

Stateのコード値を返します。

例外

ありません。

注意事項

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWActivityInstance.State

構文

public final java.lang.String toString()

機能

業務ステップの状態を示す文字列表現を取得します。

表示形式は，「状態の定数（状態のコード値）」となります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWActivityInstance.State>クラス内のtoString

戻り値

業務ステップの状態の文字列表現を返します。

例外

ありません。

注意事項

業務ステップの状態の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWActivityInstance.State

構文

public static CIWActivityInstance.State valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒9　valueOfの引数（CIWActivityInstance.Stateの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒10　valueOfで発生する例外（CIWActivityInstance.Stateの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWActivityInstance.State

構文

public static final CIWActivityInstance.State[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWActivityInstance.State c :
CIWActivityInstance.State.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.4　CIWActivityInstance.Type（業務ステップの種類の列挙型）

概要

業務ステップの種類の列挙型です。

定義

public static enum CIWActivityInstance.Type
     extends java.lang.Enum<CIWActivityInstance.Type>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWActivityInstance.Type>

含まれているインタフェース

CIWActivityInstance

定数

CIWActivityInstance.Typeの列挙型定数を次の表に示します。

表7‒11　CIWActivityInstance.Typeの列挙型定数

定数名

説明および記述形式

ERROR_NOTICE※

「エラー回復業務ステップ」を表す定数です。

完全表記形式：errorNotice

コード値：9

public static final CIWActivityInstance.Type ERROR_NOTICE

NORMAL

「一般業務ステップ」を表す定数です。

完全表記形式：normal

コード値：0

public static final CIWActivityInstance.Type NORMAL

UNDEFINED

「未定義」を表す定数です。

完全表記形式：undefined

コード値：z

public static final CIWActivityInstance.Type UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWActivityInstance.Typeのメソッドを次の表に示します。

表7‒12　CIWActivityInstance.Typeのメソッド

メソッド

説明

fromTypeCode

指定したTypeのコード値に対応した業務ステップの種類を定数に持つ，Type列挙型を返します。

toString

業務ステップの種類の文字列表現を取得します。

toType

業務ステップの種類を示すTypeの完全表記形式を取得します。

toTypeCode

業務ステップの種類を示すTypeのコード値を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromTypeCode

列挙型：CIWActivityInstance.Type

構文

public static CIWActivityInstance.Type fromTypeCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したTypeのコード値に対応した業務ステップの種類を定数に持つ，Type列挙型を返します。

引数

fromTypeCodeの引数を次の表に示します。

表7‒13　fromTypeCodeの引数（CIWActivityInstance.Typeの場合）

仮引数名

名称

in/out

説明

aCode

Typeのコード値

in

取得したいTypeのコード値を指定します。

戻り値

Typeのコード値に対応する種類を定数に持つType列挙型を返します。

例外

fromTypeCodeで発生する例外を次の表に示します。

表7‒14　fromTypeCodeで発生する例外（CIWActivityInstance.Typeの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Typeのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWActivityInstance.Type

構文

public final java.lang.String toString()

機能

業務ステップの種類の文字列表現を取得します。

表示形式は，「種類の定数（種類のコード値）」になります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWActivityInstance.Type>クラス内のtoString

戻り値

業務ステップの種類の文字列表現を返します。

例外

ありません。

注意事項

業務ステップの種類の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

toType

列挙型：CIWActivityInstance.Type

構文

public final java.lang.String toType()

機能

業務ステップの種類を示すTypeの完全表記形式を取得します。

引数

ありません。

戻り値

Typeの完全表記形式を返します。

例外

ありません。

注意事項

Typeの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toTypeCode

列挙型：CIWActivityInstance.Type

構文

public final java.lang.String toTypeCode()

機能

業務ステップの種類を示すTypeのコード値を取得します。

引数

ありません。

戻り値

Typeのコード値を返します。

例外

ありません。

注意事項

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWActivityInstance.Type

構文

public static CIWActivityInstance.Type valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒15　valueOfの引数（CIWActivityInstance.Typeの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒16　valueOfで発生する例外（CIWActivityInstance.Typeの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWActivityInstance.Type

構文

public static final CIWActivityInstance.Type[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWActivityInstance.AttributeName c :
CIWActivityInstance.Type.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.5　CIWProcessDefinition.AttributeName（ビジネスプロセス定義属性の属性名の列挙型）

概要

ビジネスプロセス定義属性の属性名の列挙型です。

定義

public static enum CIWProcessDefinition.AttributeName
     extends java.lang.Enum<CIWProcessDefinition.AttributeName>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWProcessDefinition.AttributeName>

含まれているインタフェース

CIWProcessDefinition

定数

CIWProcessDefinition.AttributeNameの列挙型定数を次の表に示します。

表7‒17　CIWProcessDefinition.AttributeNameの列挙型定数

定数名

説明および記述形式

AUTHOR

「ビジネスプロセス定義の作成者（上書き時は更新者）」を表す定数です。

public static final CIWProcessDefinition.AttributeName AUTHOR

CREATION_DATE

「ビジネスプロセス定義の作成日（上書き時は更新日）」を表す定数です。

public static final CIWProcessDefinition.AttributeName CREATION_DATE

DESCRIPTION

「ビジネスプロセス定義の説明」を表す定数です。

public static final CIWProcessDefinition.AttributeName DESCRIPTION

ID

「ビジネスプロセス定義ID」を表す定数です。

public static final CIWProcessDefinition.AttributeName ID

NAME

「ビジネスプロセス定義名称」を表す定数です。

public static final CIWProcessDefinition.AttributeName NAME

RESPONSIBLE

「ビジネスプロセス定義の管理者ID」を表す定数です。

public static final CIWProcessDefinition.AttributeName RESPONSIBLE

STATE

「ビジネスプロセス定義の状態」を表す定数です。

public static final CIWProcessDefinition.AttributeName STATE

VALID_FROM_DATE

「ビジネスプロセス定義が有効となる日（投入可能開始日）」を表す定数です。

特に指定していない場合は，無限遠の過去を表す日付情報が設定されます。無限遠の過去を表す日付情報については，CIWUtil.InfinityDate.ORIGINを参照してください。

public static final CIWProcessDefinition.AttributeName VALID_FROM_DATE

VALID_TO_DATE

「ビジネスプロセス定義が無効となる日（投入可能終了日）」を表す定数です。

特に指定していない場合は，無限遠の未来を表す日付情報が設定されます。無限遠の未来を表す日付情報については，CIWUtil.InfinityDate.BEYONDを参照してください。

public static final CIWProcessDefinition.AttributeName VALID_TO_DATE

VERSION

「ビジネスプロセス定義のバージョン」を表す定数です。

public static final CIWProcessDefinition.AttributeName VERSION

メソッド

CIWProcessDefinition.AttributeNameのメソッドを次の表に示します。

表7‒18　CIWProcessDefinition.AttributeNameのメソッド

メソッド

説明

toAttributeName

ビジネスプロセス定義属性の属性名（属性を格納するテーブルのカラム名）を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toAttributeName

列挙型：CIWProcessDefinition.AttributeName

構文

public final java.lang.String toAttributeName()

機能

ビジネスプロセス定義属性の属性名（属性を格納するテーブルのカラム名）を取得します。

引数

ありません。

戻り値

ビジネスプロセス定義属性の属性名を返します。

例外

ありません。

valueOf

列挙型：CIWProcessDefinition.AttributeName

構文

public static CIWProcessDefinition.AttributeName valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒19　valueOfの引数（CIWProcessDefinition.AttributeNameの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒20　valueOfで発生する例外（CIWProcessDefinition.AttributeNameの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWProcessDefinition.AttributeName

構文

public static final CIWProcessDefinition.AttributeName[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWProcessDefinition.AttributeName c :
CIWProcessDefinition.AttributeName.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.6　CIWProcessDefinition.State（ビジネスプロセス定義の状態の列挙型）

概要

ビジネスプロセス定義の状態の列挙型です。

定義

public static enum CIWProcessDefinition.State
     extends java.lang.Enum<CIWProcessDefinition.State>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWProcessDefinition.State>

含まれているインタフェース

CIWProcessDefinition

定数

CIWProcessDefinition.Stateの列挙型定数を次の表に示します。

表7‒21　CIWProcessDefinition.Stateの列挙型定数

定数名

説明および記述形式

ACTIVE

「活性」を表す定数です。

短縮表記形式：active

完全表記形式：active

コード値：b

public static final CIWProcessDefinition.State ACTIVE

INACTIVE

「非活性」を表す定数です。

短縮表記形式：inactive

完全表記形式：inactive

コード値：a

public static final CIWProcessDefinition.State INACTIVE

UNDEFINED

「未定義」を表す定数です。

短縮表記形式：undefined

完全表記形式：undefined

コード値：z

public static final CIWProcessDefinition.State UNDEFINED

メソッド

CIWProcessDefinition.Stateのメソッドを次の表に示します。

表7‒22　CIWProcessDefinition.Stateのメソッド

メソッド

説明

fromStateCode

指定したStateのコード値に対応したビジネスプロセス定義の状態を定数に持つ，State列挙型を返します。

toShortState

ビジネスプロセス定義の状態を示すStateの短縮表記形式を取得します。

toState

ビジネスプロセス定義の状態を示すStateの完全表記形式を取得します。

toStateCode

ビジネスプロセス定義の状態を示すStateのコード値を取得します。

toString

ビジネスプロセス定義の状態の文字列表現を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromStateCode

列挙型：CIWProcessDefinition.State

構文

public static CIWProcessDefinition.State fromStateCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したStateのコード値に対応したビジネスプロセス定義の状態を定数に持つ，State列挙型を返します。

引数

fromStateCodeの引数を次の表に示します。

表7‒23　fromStateCodeの引数（CIWProcessDefinition.Stateの場合）

仮引数名

名称

in/out

説明

aCode

Stateのコード値

in

取得したいStateのコード値を指定します。

戻り値

Stateのコード値に対応する状態を定数に持つState列挙型を返します。

例外

fromStateCodeで発生する例外を次の表に示します。

表7‒24　fromStateCodeで発生する例外（CIWProcessDefinition.Stateの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Stateのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toShortState

列挙型：CIWProcessDefinition.State

構文

public final java.lang.String toShortState()

機能

ビジネスプロセス定義の状態を示すStateの短縮表記形式を取得します。

引数

ありません。

戻り値

Stateの短縮表記形式を返します。

例外

ありません。

注意事項

Stateの短縮表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toState

列挙型：CIWProcessDefinition.State

構文

public final java.lang.String toState()

機能

ビジネスプロセス定義の状態を示すStateの完全表記形式を取得します。

引数

ありません。

戻り値

Stateの完全表記形式を返します。

例外

ありません。

注意事項

Stateの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toStateCode

列挙型：CIWProcessDefinition.State

構文

public final java.lang.String toStateCode()

機能

ビジネスプロセス定義の状態を示すStateのコード値を取得します。

引数

ありません。

戻り値

Stateのコード値を返します。

例外

ありません。

注意事項

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWProcessDefinition.State

構文

public final java.lang.String toString()

機能

ビジネスプロセス定義の状態の文字列表現を取得します。

表示形式は，「状態の定数（状態のコード値）」になります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWProcessDefinition.State>クラス内のtoString

戻り値

ビジネスプロセス定義の状態の文字列表現を返します。

例外

ありません。

注意事項

ビジネスプロセス定義の状態の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWProcessDefinition.State

構文

public static CIWProcessDefinition.State valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒25　valueOfの引数（CIWProcessDefinition.Stateの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒26　valueOfで発生する例外（CIWProcessDefinition.Stateの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWProcessDefinition.State

構文

public static final CIWProcessDefinition.State[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWProcessDefinition.State c :
CIWProcessDefinition.State.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.7　CIWProcessInstance.AttributeName（案件属性の属性名の列挙型）

概要

案件属性の属性名の列挙型です。

定義

public static enum CIWProcessInstance.AttributeName
     extends java.lang.Enum<CIWProcessInstance.AttributeName>

すべての実装されたインタフェース

java.io.Serializable,
java.lang.Comparable<CIWProcessInstance.AttributeName>

含まれているインタフェース

CIWProcessInstance

定数

CIWProcessInstance.AttributeNameの列挙型定数を次の表に示します。

表7‒27　CIWProcessInstance.AttributeNameの列挙型定数

定数名

説明および記述形式

CLOSED_DATE

「案件の終了日時」を表す定数です。

public static final CIWProcessInstance.AttributeName CLOSED_DATE

CREATOR

「案件の投入者」を表す定数です。

public static final CIWProcessInstance.AttributeName CREATOR

DEADLINE

「案件の処理期限の絶対日時」を表す定数です。

案件開始時に，ビジネスプロセス定義の処理期限ルールに従い，案件の開始日時（START_DATE）を起算日として算出された値が設定されます。ただし，すでにAPIによって明示的に値を設定している場合は，処理期限ルールは適用されません。値を設定していない場合は，nullが設定されています。

public static final CIWProcessInstance.AttributeName DEADLINE

ID

「案件のID」を表す定数です。

public static final CIWProcessInstance.AttributeName ID

MOVED_DATE

「案件の乗せ替え日時」を表す定数です。

public static final CIWProcessInstance.AttributeName MOVED_DATE

NAME

「案件の名称（案件キー）」を表す定数です。

public static final CIWProcessInstance.AttributeName NAME

PRIORITY

「案件の優先度」を表す定数です。

public static final CIWProcessInstance.AttributeName PRIORITY

PROCESS_DEFINITION_ID

「案件が所属するビジネスプロセス定義のID」を表す定数です。

public static final CIWProcessInstance.AttributeName PROCESS_DEFINITION_ID

PROCESS_DEFINITION_NAME

「案件が所属するビジネスプロセス定義の名称」を表す定数です。

public static final CIWProcessInstance.AttributeName PROCESS_DEFINITION_NAME

START_DATE

「案件の開始日時」を表す定数です。

public static final CIWProcessInstance.AttributeName START_DATE

STATE

「案件の状態」を表す定数です。

public static final CIWProcessInstance.AttributeName STATE

メソッド

CIWProcessInstance.AttributeNameのメソッドを次の表に示します。

表7‒28　CIWProcessInstance.AttributeNameのメソッド

メソッド

説明

toAttributeName

案件属性の属性名（属性を格納するテーブルのカラム名）を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toAttributeName

列挙型：CIWProcessInstance.AttributeName

構文

public final java.lang.String toAttributeName()

機能

案件属性の属性名（属性を格納するテーブルのカラム名）を取得します。

引数

ありません。

戻り値

案件属性の属性名を返します。

例外

ありません。

valueOf

列挙型：CIWProcessInstance.AttributeName

構文

public static CIWProcessInstance.AttributeName valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒29　valueOfの引数（CIWProcessInstance.AttributeNameの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒30　valueOfで発生する例外（CIWProcessInstance.AttributeNameの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWProcessInstance.AttributeName

構文

public static final CIWProcessInstance.AttributeName[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWProcessDefinition.AttributeName c :
CIWProcessDefinition.AttributeName.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.8　CIWProcessInstance.State（案件の状態の列挙型）

概要

案件の状態の列挙型です。

定義

public static enum CIWProcessInstance.State
     extends java.lang.Enum<CIWProcessInstance.State>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWProcessInstance.State>

含まれているインタフェース

CIWProcessInstance

定数

CIWProcessInstance.Stateの列挙型定数を次の表に示します。

表7‒31　CIWProcessInstance.Stateの列挙型定数

定数名

説明および記述形式

ABORTED※

「異常終了」を表す定数です。

短縮表記形式：aborted

完全表記形式：closed.aborted

コード値：v

public static final CIWProcessInstance.State ABORTED

COMPLETED

「完了」を表す定数です。

短縮表記形式：completed

完全表記形式：closed.completed

コード値：o

public static final CIWProcessInstance.State COMPLETED

INTERMITTED

「実行停止」を表す定数です。

短縮表記形式：intermitted

完全表記形式：open.notRunning.suspended.intermitted

コード値：m

public static final CIWProcessInstance.State INTERMITTED

NOT_STARTED

「未実行」を表す定数です。

短縮表記形式：notStarted

完全表記形式：open.notRunning.notStarted

コード値：h

public static final CIWProcessInstance.State NOT_STARTED

RUNNING

「実行中」を表す定数です。

短縮表記形式：running

完全表記形式：open.running

コード値：d

public static final CIWProcessInstance.State RUNNING

TERMINATED

「強制終了」を表す定数です。

短縮表記形式：terminated

完全表記形式：closed.terminated

コード値：u

public static final CIWProcessInstance.State TERMINATED

UNDEFINED

「未定義」を表す定数です。

短縮表記形式：undefined

完全表記形式：undefined

コード値：z

public static final CIWProcessInstance.State UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWProcessInstance.Stateのメソッドを次の表に示します。

表7‒32　CIWProcessInstance.Stateのメソッド

メソッド

説明

fromStateCode

指定したStateのコード値に対応した案件の状態を定数に持つ，State列挙型を返します。

isClosed

案件が「終了」状態かどうかを判定します。

isNotRunning

案件が「停止中」状態かどうかを判定します。

isOpen

案件が「未終了」状態かどうかを判定します。

isSuspended

案件が「中断」状態かどうかを判定します。

toShortState

案件の状態を示すStateの短縮表記形式を取得します。

toState

案件の状態を示すStateの完全表記形式を取得します。

toStateCode

案件の状態を示すStateのコード値を取得します。

toString

案件の状態の文字列表現を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromStateCode

列挙型：CIWProcessInstance.State

構文

public static CIWProcessInstance.State fromStateCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したStateのコード値に対応した案件の状態を定数に持つ，State列挙型を返します。

引数

fromStateCodeの引数を次の表に示します。

表7‒33　fromStateCodeの引数（CIWProcessInstance.Stateの場合）

仮引数名

名称

in/out

説明

aCode

Stateのコード値

in

取得したいStateのコード値を指定します。

戻り値

Stateのコード値に対応する状態を定数に持つState列挙型を返します。

例外

fromStateCodeで発生する例外を次の表に示します。

表7‒34　fromStateCodeで発生する例外（CIWProcessInstance.Stateの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Stateのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

isClosed

列挙型：CIWProcessInstance.State

構文

public boolean isClosed()

機能

案件が「終了」状態かどうかを判定します。

引数

ありません。

戻り値

案件が「終了」状態の場合はtrueを返します。

案件が「終了」状態以外の場合はfalseを返します。

例外

ありません。

isNotRunning

列挙型：CIWProcessInstance.State

構文

public boolean isNotRunning()

機能

案件が「停止中」状態かどうかを判定します。

引数

ありません。

戻り値

案件が「停止中」状態の場合はtrueを返します。

案件が「停止中」状態以外の場合はfalseを返します。

例外

ありません。

isOpen

列挙型：CIWProcessInstance.State

構文

public boolean isOpen()

機能

案件が「未終了」状態かどうかを判定します。

引数

ありません。

戻り値

案件が「未終了」状態の場合はtrueを返します。

案件が「未終了」状態以外の場合はfalseを返します。

例外

ありません。

isSuspended

列挙型：CIWProcessInstance.State

構文

public boolean isSuspended()

機能

案件が「中断」状態かどうかを判定します。

引数

ありません。

戻り値

案件が「中断」状態の場合はtrueを返します。

案件が「中断」状態以外の場合はfalseを返します。

例外

ありません。

toShortState

列挙型：CIWProcessInstance.State

構文

public final java.lang.String toShortState()

機能

案件の状態を示すStateの短縮表記形式を取得します。

引数

ありません。

戻り値

Stateの短縮表記形式を返します。

例外

ありません。

注意事項

Stateの短縮表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toState

列挙型：CIWProcessInstance.State

構文

public final java.lang.String toState()

機能

案件の状態を示すStateの完全表記形式を取得します。

引数

ありません。

戻り値

Stateの完全表記形式を返します。

例外

ありません。

注意事項

Stateの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toStateCode

列挙型：CIWProcessInstance.State

構文

public final java.lang.String toStateCode()

機能

案件の状態を示すStateのコード値を取得します。

引数

ありません。

戻り値

StateCodeの値を返します。

例外

ありません。

注意事項

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWProcessInstance.State

構文

public final java.lang.String toString()

機能

案件の状態の文字列表現を取得します。

表示形式は，「状態の定数（状態のコード値）」になります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWProcessInstance.State>クラス内のtoString

戻り値

案件の状態の文字列表現を返します。

例外

ありません。

注意事項

案件の状態の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWProcessInstance.State

構文

public static CIWProcessInstance.State valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒35　valueOfの引数（CIWProcessInstance.Stateの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒36　valueOfで発生する例外（CIWProcessInstance.Stateの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWProcessInstance.State

構文

public static final CIWProcessInstance.State[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWProcessInstance.State c :
CIWProcessInstance.State.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.9　CIWServer.Targetkind（ワーク管理システムが管理するオブジェクトの種別を表す列挙型）

概要

ワーク管理システムが管理するオブジェクトの種別を表す列挙型です。

定義

public static enum CIWServer.Targetkind
     extends java.lang.Enum<CIWServer.Targetkind>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWServer.Targetkind>

含まれているインタフェース

CIWServer

定数

CIWServer.Targetkindの列挙型定数を次の表に示します。

表7‒37　CIWServer.Targetkindの列挙型定数

定数名

説明および記述形式

ACTIVITY_INSTANCE

「業務ステップ」を表す定数です。

public static final CIWServer.Targetkind ACTIVITY_INSTANCE

PROCESS_DEFINITION

「ビジネスプロセス定義」を表す定数です。

public static final CIWServer.Targetkind PROCESS_DEFINITION

PROCESS_INSTANCE

「案件」を表す定数です。

public static final CIWServer.Targetkind PROCESS_INSTANCE

WORK_DEFINITION

「作業定義」を表す定数です。

public static final CIWServer.Targetkind WORK_DEFINITION

WORK_ITEM

「作業」を表す定数です。

public static final CIWServer.Targetkind WORK_ITEM

メソッド

CIWServer.Targetkindのメソッドを次の表に示します。

表7‒38　CIWServer.Targetkindのメソッド

メソッド

説明

toTargetkind

ワーク管理システムが管理するオブジェクトの種別の名称を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toTargetkind

列挙型：CIWServer.Targetkind

構文

public final java.lang.String toTargetkind()

機能

ワーク管理システムが管理するオブジェクトの種別の名称を取得します。

引数

ありません。

戻り値

ワーク管理システムが管理するオブジェクトの種別の名称を返します。

例外

ありません。

valueOf

列挙型：CIWServer.Targetkind

構文

public static CIWServer.Targetkind valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒39　valueOfの引数（CIWServer.Targetkindの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒40　valueOfで発生する例外valueOfの引数（CIWServer.Targetkindの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWServer.Targetkind

構文

public static final CIWServer.Targetkind[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWServer.Targetkind c :
CIWServer.Targetkind.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.10　CIWUtil.InfinityDate（無限遠の日付の列挙型）

概要

無限遠の日付の列挙型です。

定義

public static enum CIWUtil.InfinityDate
     extends java.lang.Enum<CIWUtil.InfinityDate>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWUtil.InfinityDate>

含まれているインタフェース

CIWUtil

定数

CIWUtil.InfinityDateの列挙型定数を次の表に示します。

表7‒41　CIWUtil.InfinityDateの列挙型定数

定数名

説明および記述形式

BEYOND

「無限遠の未来」を表す定数です。

日付情報を取得するメソッドによって，無限遠の未来を表す日付情報を取得した場合，292278994/08/17 07:12:55 GMTを表すjava.util.Date型オブジェクトが取得されます。

日付情報を取得するメソッドによって取得される，無限遠の未来を表す日付情報の値は，将来変更される場合があります。

public static final CIWUtil.InfinityDate BEYOND

ORIGIN

「無限遠の過去」を表す定数です。

日付情報を取得するメソッドによって，無限遠の過去を表す日付情報を取得した場合，1970/01/01 00:00:00 GMTを表すjava.util.Date型オブジェクトが取得されます。

日付情報を取得するメソッドによって取得される，無限遠の過去を表す日付情報の値は，将来変更される場合があります。

public static final CIWUtil.InfinityDate ORIGIN

メソッド

CIWUtil.InfinityDateのメソッドを次の表に示します。

表7‒42　CIWUtil.InfinityDateのメソッド

メソッド

説明

toDate

定数の表す日付情報を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toDate

列挙型：CIWUtil.InfinityDate

構文

public final java.util.Date toDate()

機能

定数の表す日付情報を取得します。

引数

ありません。

戻り値

定数の表す日付情報を返します。

例外

ありません。

valueOf

列挙型：CIWUtil.InfinityDate

構文

public static CIWUtil.InfinityDate valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒43　valueOfの引数（CIWUtil.InfinityDateの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒44　valueOfで発生する例外（CIWUtil.InfinityDateの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWUtil.InfinityDate

構文

public static final CIWUtil.InfinityDate[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWUtil.InfinityDate c :
CIWUtil.InfinityDate.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.11　CIWWorkDefinition.AttributeName（作業定義属性の属性名の列挙型）

概要

作業定義属性の属性名の列挙型です。

定義

public static enum CIWWorkDefinition.AttributeName
     extends java.lang.Enum<CIWWorkDefinition.AttributeName>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWWorkDefinition.AttributeName>

含まれているインタフェース

CIWWorkDefinition

定数

CIWWorkDefinition.AttributeNameの列挙型定数を次の表に示します。

表7‒45　CIWWorkDefinition.AttributeNameの列挙型定数

定数名

説明および記述形式

ACTIVITY_DEFINITION_ID

「作業定義が所属する業務ステップ定義のID」を表す定数です。

public static final CIWWorkDefinition.AttributeName ACTIVITY_DEFINITION_ID

CASTING_RULE_NAME

「振り分けルール名」を表す定数です。

public static final CIWWorkDefinition.AttributeName CASTING_RULE_NAME

DESCRIPTION

「作業の説明」を表す定数です。

public static final CIWWorkDefinition.AttributeName DESCRIPTION

ID

「作業定義のID」を表す定数です。

public static final CIWWorkDefinition.AttributeName ID

NAME

「作業定義の名称」を表す定数です。

public static final CIWWorkDefinition.AttributeName NAME

PROCESS_DEFINITION_ID

「作業定義が所属するビジネスプロセス定義のID」を表す定数です。

public static final CIWWorkDefinition.AttributeName PROCESS_DEFINITION_ID

TYPE

「作業の種類」を表す定数です。

public static final CIWWorkDefinition.AttributeName TYPE

メソッド

CIWWorkDefinition.AttributeNameのメソッドを次の表に示します。

表7‒46　CIWWorkDefinition.AttributeNameのメソッド

メソッド

説明

toAttributeName

作業定義属性の属性名（属性を格納するテーブルのカラム名）を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toAttributeName

列挙型：CIWWorkDefinition.AttributeName

構文

public final java.lang.String toAttributeName()

機能

作業定義属性の属性名（属性を格納するテーブルのカラム名）を取得します。

引数

ありません。

戻り値

作業定義属性の属性名を返します。

例外

ありません。

valueOf

列挙型：CIWWorkDefinition.AttributeName

構文

public static CIWWorkDefinition.AttributeName valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒47　valueOfの引数（CIWWorkDefinition.AttributeNameの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒48　valueOfで発生する例外（CIWWorkDefinition.AttributeNameの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkDefinition.AttributeName

構文

public static final CIWWorkDefinition.AttributeName[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkDefinition.AttributeName c :
CIWWorkDefinition.AttributeName.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.12　CIWWorkDefinition.Type（作業定義の種類の列挙型）

概要

作業定義の種類の列挙型です。

定義

public static enum CIWWorkDefinition.Type
     extends java.lang.Enum<CIWWorkDefinition.Type>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWWorkDefinition.Type>

含まれているインタフェース

CIWWorkDefinition

定数

CIWWorkDefinition.Typeの列挙型定数を次の表に示します。

表7‒49　CIWWorkDefinition.Typeの列挙型定数

定数名

説明および記述形式

BUILTIN_CONCURRENT_ACTIVITY※

「並列業務ステップ作業」を表す定数です。

完全表記形式：builtin.concurrentActivity

コード値：a

public static final CIWWorkDefinition.Type BUILTIN_CONCURRENT_ACTIVITY

BUILTIN_CONCURRENT_WORK

「並列作業」を表す定数です。

完全表記形式：builtin.concurrentWork

コード値：b

public static final CIWWorkDefinition.Type BUILTIN_CONCURRENT_WORK

BUILTIN_FOLLOWING_ACTIVITY※

「先手通知作業」を表す定数です。

完全表記形式：builtin.followingActivity

コード値：d

public static final CIWWorkDefinition.Type BUILTIN_FOLLOWING_ACTIVITY

BUILTIN_TIMER※

「計時作業」を表す定数です。

完全表記形式：builtin.timer

コード値：c

public static final CIWWorkDefinition.Type BUILTIN_TIMER

NORMAL

「一般作業」を表す定数です。

完全表記形式：normal

コード値：0

public static final CIWWorkDefinition.Type NORMAL

UNDEFINED

「未定義」を表す定数です。

完全表記形式：undefined

コード値：z

public static final CIWWorkDefinition.Type UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWWorkDefinition.Typeのメソッドを次の表に示します。

表7‒50　CIWWorkDefinition.Typeのメソッド

メソッド

説明

fromTypeCode

指定したTypeのコード値に対応した作業定義の種類を定数に持つ，Type列挙型を返します。

toString

作業定義の種類の文字列表現を取得します。

toType

作業定義の種類を示すTypeの完全表記形式を取得します。

toTypeCode

作業定義の種類を示すTypeのコード値を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromTypeCode

列挙型：CIWWorkDefinition.Type

構文

public static CIWWorkDefinition.Type fromTypeCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したTypeのコード値に対応した作業定義の種類を定数に持つ，Type列挙型を返します。

引数

fromTypeCodeの引数を次の表に示します。

表7‒51　fromTypeCodeの引数（CIWWorkDefinition.Typeの場合）

仮引数名

名称

in/out

説明

aCode

Typeのコード値

in

取得したいTypeのコード値を指定します。

戻り値

Typeのコード値に対応する種類を定数に持つType列挙型を返します。

例外

fromTypeCodeで発生する例外を次の表に示します。

表7‒52　fromTypeCodeで発生する例外（CIWWorkDefinition.Typeの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Typeのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWWorkDefinition.Type

構文

public final java.lang.String toString()

機能

作業定義の種類の文字列表現を取得します。

表示形式は，「種類の定数（種類のコード値）」になります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWWorkDefinition.Type>クラス内のtoString

戻り値

作業定義の種類の文字列表現を返します。

例外

ありません。

注意事項

作業定義の種類の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

toType

列挙型：CIWWorkDefinition.Type

構文

public final java.lang.String toType()

機能

作業定義の種類を示すTypeの完全表記形式を取得します。

引数

ありません。

戻り値

Typeの完全表記形式を返します。

例外

ありません。

注意事項

Typeの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toTypeCode

列挙型：CIWWorkDefinition.Type

構文

public final java.lang.String toTypeCode()

機能

作業定義の種類を示すTypeのコード値を取得します。

引数

ありません。

戻り値

Typeのコード値を返します。

例外

ありません。

注意事項

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWWorkDefinition.Type

構文

public static CIWWorkDefinition.Type valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒53　valueOfの引数（CIWWorkDefinition.Typeの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒54　valueOfで発生する例外（CIWWorkDefinition.Typeの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkDefinition.Type

構文

public static final CIWWorkDefinition.Type[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkDefinition.Type c :
CIWWorkDefinition.Type.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.13　CIWWorkItem.AttributeName（作業属性の属性名の列挙型）

概要

作業属性の属性名の列挙型です。

定義

public static enum CIWWorkItem.AttributeName
     extends java.lang.Enum<CIWWorkItem.AttributeName>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWWorkItem.AttributeName>

含まれているインタフェース

CIWWorkItem

定数

CIWWorkItem.AttributeNameの列挙型定数を次の表に示します。

表7‒55　CIWWorkItem.AttributeNameの列挙型定数

定数名

説明および記述形式

ACTIVITY_INSTANCE_ID

「作業が所属する業務ステップのID」を表す定数です。

public static final CIWWorkItem.AttributeName ACTIVITY_INSTANCE_ID

CLOSED_DATE

「作業の終了日時」を表す定数です。

public static final CIWWorkItem.AttributeName CLOSED_DATE

CREATION_DATE

「作業の発生日時」を表す定数です。

public static final CIWWorkItem.AttributeName CREATION_DATE

DEADLINE

「作業の処理期限の絶対日時」を表す定数です。

作業生成時に，所属する業務ステップの処理期限に設定されている値が，作業の処理期限として設定されます。

未設定時は，nullが設定されています。

public static final CIWWorkItem.AttributeName DEADLINE

ID

「作業のID」を表す定数です。

public static final CIWWorkItem.AttributeName ID

NAME

「作業の名称（作業キー）」を表す定数です。

public static final CIWWorkItem.AttributeName NAME

PARTICIPANT

「作業者のID」を表す定数です。

public static final CIWWorkItem.AttributeName PARTICIPANT

PRIORITY

「作業の優先度」を表す定数です。

public static final CIWWorkItem.AttributeName PRIORITY

PROCESS_DEFINITION_ID

「作業が所属するビジネスプロセス定義のID」を表す定数です。

public static final CIWWorkItem.AttributeName PROCESS_DEFINITION_ID

PROCESS_INSTANCE_ID

「作業が所属する案件のID」を表す定数です。

public static final CIWWorkItem.AttributeName PROCESS_INSTANCE_ID

PROCESS_INSTANCE_NAME

「案件名（案件キー）」を表す定数です。

public static final CIWWorkItem.AttributeName PROCESS_INSTANCE_NAME

START_DATE

「作業の開始日時」を表す定数です。

public static final CIWWorkItem.AttributeName START_DATE

STATE

「作業の状態」を表す定数です。

public static final CIWWorkItem.AttributeName STATE

TYPE

「作業の種類」を表す定数です。

public static final CIWWorkItem.AttributeName TYPE

WORK_DEFINITION_ID

「作業定義のID」を表す定数です。

public static final CIWWorkItem.AttributeName WORK_DEFINITION_ID

WORK_DEFINITION_NAME

「作業定義の名称」を表す定数です。

public static final CIWWorkItem.AttributeName WORK_DEFINITION_NAME

メソッド

CIWWorkItem.AttributeNameのメソッドを次の表に示します。

表7‒56　CIWWorkItem.AttributeNameのメソッド

メソッド

説明

toAttributeName

作業属性の属性名（属性を格納するテーブルのカラム名）を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，toString，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

toAttributeName

列挙型：CIWWorkItem.AttributeName

構文

public final java.lang.String toAttributeName()

機能

作業属性の属性名（属性を格納するテーブルのカラム名）を取得します。

引数

ありません。

戻り値

作業属性の属性名を返します。

例外

ありません。

valueOf

列挙型：CIWWorkItem.AttributeName

構文

public static CIWWorkItem.AttributeName valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒57　valueOfの引数（CIWWorkItem.AttributeNameの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒58　valueOfで発生する例外（CIWWorkItem.AttributeNameの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkItem.AttributeName

構文

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

public static final CIWWorkItem.AttributeName[]
     values()

機能

for(CIWWorkItem.AttributeName c :
CIWWorkItem.AttributeName.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.14　CIWWorkItem.State（作業の状態の列挙型）

概要

作業の状態の列挙型です。

定義

public static enum CIWWorkItem.State
     extends java.lang.Enum<CIWWorkItem.State>

すべての実装されたインタフェース

java.io.Serializable,
java.lang.Comparable<CIWWorkItem.State>

含まれているインタフェース

CIWWorkItem

定数

CIWWorkItem.Stateの列挙型定数を次の表に示します。

表7‒59　CIWWorkItem.Stateの列挙型定数

定数名

説明および記述形式

ABORTED※

「異常終了」を表す定数です。

短縮表記形式：aborted

完全表記形式：closed.aborted

コード値：v

public static final CIWWorkItem.State ABORTED

CANCELED

「実行取消」を表す定数です。

短縮表記形式：canceled

完全表記形式：closed.completed.canceled

コード値：q

public static final CIWWorkItem.State CANCELED

DISABLED

「実行開始不可」を表す定数です。

短縮表記形式：disabled

完全表記形式：open.notRunning.suspended.disabled

コード値：l

public static final CIWWorkItem.State DISABLED

EXECUTED

「実行済」を表す定数です。

短縮表記形式：executed

完全表記形式：closed.completed.executed

コード値：r

public static final CIWWorkItem.State EXECUTED

EXECUTING

「自動実行」を表す定数です。

短縮表記形式：executing

完全表記形式：open.running.executing

コード値：e

public static final CIWWorkItem.State EXECUTING

INITIAL

「初期」を表す定数です。

短縮表記形式：initial

完全表記形式：open.notRunning.notStarted.initial

コード値：i

public static final CIWWorkItem.State INITIAL

INTERMITTED

「実行停止」を表す定数です。

短縮表記形式：intermitted

完全表記形式：open.notRunning.suspended.intermitted

コード値：m

public static final CIWWorkItem.State INTERMITTED

NOT_EXECUTED

「実行省略」を表す定数です。

短縮表記形式：notExecuted

完全表記形式：closed.completed.notExecuted

コード値：p

public static final CIWWorkItem.State NOT_EXECUTED

PERFORMING

「作業者実行」を表す定数です。

短縮表記形式：performing

完全表記形式：open.running.performing

コード値：f

public static final CIWWorkItem.State PERFORMING

READY

「実行開始可能」を表す定数です。

短縮表記形式：ready

完全表記形式：open.notRunning.notStarted.ready

コード値：j

public static final CIWWorkItem.State READY

RUNNING

「実行中」を表す定数です。

短縮表記形式：running

完全表記形式：open.running

コード値：d

public static final CIWWorkItem.State RUNNING

TERMINATED

「強制終了」を表す定数です。

短縮表記形式：terminated

完全表記形式：closed.terminated

コード値：u

public static final CIWWorkItem.State TERMINATED

UNDEFINED

「未定義」を表す定数です。

短縮表記形式：undefined

完全表記形式：undefined

コード値：z

public static final CIWWorkItem.State UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWWorkItem.Stateのメソッドを次の表に示します。

表7‒60　CIWWorkItem.Stateのメソッド

メソッド

説明

fromStateCode

指定したStateのコード値に対応した作業の状態を定数に持つ，State列挙型を返します。

isClosed

作業が「終了」状態かどうかを判定します。

isCompleted

作業が「完了」状態かどうかを判定します。

isNotRunning

作業が「停止中」状態かどうかを判定します。

isNotStarted

作業が「未実行」状態かどうかを判定します。

isOpen

作業が「未終了」状態かどうかを判定します。

isRunning

作業が「実行中」状態かどうかを判定します。

isSuspended

作業が「中断」状態かどうかを判定します。

toShortState

作業の状態を示すStateの短縮表記形式を取得します。

toState

作業の状態を示すStateの完全表記形式を取得します。

toStateCode

作業の状態を示すStateのコード値を取得します。

toString

作業の状態の文字列表現を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromStateCode

列挙型：CIWWorkItem.State

構文

public static CIWWorkItem.State fromStateCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したStateのコード値に対応した作業の状態を定数に持つ，State列挙型を返します。

引数

fromStateCodeの引数を次の表に示します。

表7‒61　fromStateCodeの引数（CIWWorkItem.Stateの場合）

仮引数名

名称

in/out

説明

aCode

Stateのコード値

in

取得したいStateのコード値を指定します。

戻り値

Stateのコード値に対応する状態を定数に持つState列挙型を返します。

例外

fromStateCodeで発生する例外を次の表に示します。

表7‒62　fromStateCodeで発生する例外（CIWWorkItem.Stateの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Stateのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

isClosed

列挙型：CIWWorkItem.State

構文

public boolean isClosed()

機能

作業が「終了」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「終了」状態の場合はtrueを返します。

作業が「終了」状態以外の場合はfalseを返します。

例外

ありません。

isCompleted

列挙型：CIWWorkItem.State

構文

public boolean isCompleted()

機能

作業が「完了」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「完了」状態の場合はtrueを返します。

作業が「完了」状態以外の場合はfalseを返します。

例外

ありません。

isNotRunning

列挙型：CIWWorkItem.State

構文

public boolean isNotRunning()

機能

作業が「停止中」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「停止中」状態の場合はtrueを返します。

作業が「停止中」状態以外の場合はfalseを返します。

例外

ありません。

isNotStarted

列挙型：CIWWorkItem.State

構文

public boolean isNotStarted()

機能

作業が「未実行」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「未実行」状態の場合はtrueを返します。

作業が「未実行」状態以外の場合はfalseを返します。

例外

ありません。

isOpen

列挙型：CIWWorkItem.State

構文

public boolean isOpen()

機能

作業が「未終了」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「未終了」状態の場合はtrueを返します。

作業が「未終了」状態以外の場合はfalseを返します。

例外

ありません。

isRunning

列挙型：CIWWorkItem.State

構文

public boolean isRunning()

機能

作業が「実行中」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「実行中」状態の場合はtrueを返します。

作業が「実行中」状態以外の場合はfalseを返します。

例外

ありません。

isSuspended

列挙型：CIWWorkItem.State

構文

public boolean isSuspended()

機能

作業が「中断」状態かどうかを判定します。

引数

ありません。

戻り値

作業が「中断」状態の場合はtrueを返します。

作業が「中断」状態以外の場合はfalseを返します。

例外

ありません。

toShortState

列挙型：CIWWorkItem.State

構文

public final java.lang.String toShortState()

機能

作業の状態を示すStateの短縮表記形式を取得します。

引数

ありません。

戻り値

Stateの短縮表記形式を返します。

例外

ありません。

注意事項

Stateの短縮表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toState

列挙型：CIWWorkItem.State

構文

public final java.lang.String toState()

機能

作業の状態を示すStateの完全表記形式を取得します。

引数

ありません。

戻り値

Stateの完全表記形式を返します。

例外

ありません。

注意事項

Stateの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toStateCode

列挙型：CIWWorkItem.State

構文

public final java.lang.String toStateCode()

機能

作業の状態を示すStateのコード値を取得します。

引数

ありません。

戻り値

Stateのコード値を返します。

例外

ありません。

注意事項

Stateのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWWorkItem.State

構文

public final java.lang.String toString()

機能

作業の状態の文字列表現を取得します。

表示形式は，「状態の定数（状態のStateCodeの値）」となります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWWorkItem.State>クラス内のtoString

戻り値

作業の状態の文字列表現を返します。

例外

ありません。

注意事項

作業の状態の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWWorkItem.State

構文

public static CIWWorkItem.State valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒63　valueOfの引数（CIWWorkItem.Stateの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒64　valueOfで発生する例外（CIWWorkItem.Stateの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkItem.State

構文

public static final CIWWorkItem.State[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkItem.State c :
CIWWorkItem.State.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

7.15　CIWWorkItem.Type（作業の種類の列挙型）

概要

作業の種類の列挙型です。

定義

public static enum CIWWorkItem.Type
     extends java.lang.Enum<CIWWorkItem.Type>

すべての実装されたインタフェース

java.io.Serializable,
     java.lang.Comparable<CIWWorkItem.Type>

含まれているインタフェース

CIWWorkItem

定数

CIWWorkItem.Typeの列挙型定数を次の表に示します。

表7‒65　CIWWorkItem.Typeの列挙型定数

定数名

説明および記述形式

BUILTIN_CONCURRENT_ACTIVITY※

「並列業務ステップ作業」を表す定数です。

完全表記形式：builtin.concurrentActivity

コード値：a

public static final CIWWorkItem.Type BUILTIN_CONCURRENT_ACTIVITY

BUILTIN_CONCURRENT_WORK

「並列作業」を表す定数です。

完全表記形式：builtin.concurrentWork

コード値：b

public static final CIWWorkItem.Type BUILTIN_CONCURRENT_WORK

BUILTIN_FOLLOWING_ACTIVITY※

「先手通知作業」を表す定数です。

完全表記形式：builtin.followingActivity

コード値：d

public static final CIWWorkItem.Type BUILTIN_FOLLOWING_ACTIVITY

BUILTIN_TIMER※

「計時作業」を表す定数です。

完全表記形式：builtin.timer

コード値：c

public static final CIWWorkItem.Type BUILTIN_TIMER

ERROR_NOTICE※

「エラー回復作業」を表す定数です。

完全表記形式：errorNotice

コード値：9

public static final CIWWorkItem.Type ERROR_NOTICE

NORMAL

「一般作業」を表す定数です。

完全表記形式：normal

コード値：0

public static final CIWWorkItem.Type NORMAL

UNDEFINED

「未定義」を表す定数です。

完全表記形式：undefined

コード値：z

public static final CIWWorkItem.Type UNDEFINED

注※

CSCIWではサポートしていません。

メソッド

CIWWorkItem.Typeのメソッドを次の表に示します。

表7‒66　CIWWorkItem.Typeのメソッド

メソッド

説明

fromTypeCode

指定したTypeのコード値に対応した作業の種類を定数に持つ，Type列挙型を返します。

toString

作業の種類の文字列表現を取得します。

toType

作業の種類を示すTypeの完全表記形式を取得します。

toTypeCode

作業の種類を示すTypeのコード値を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数が含まれている配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone，compareTo，equals，getDeclaringClass，hashCode，name，ordinal，valueOf

java.lang.Objectクラスから継承されたメソッド

finalize，getClass，notify，notifyAll，wait，wait，wait

fromTypeCode

列挙型：CIWWorkItem.Type

構文

public static CIWWorkItem.Type fromTypeCode(
     java.lang.String aCode
)
     throws CIWFatalException

機能

指定したTypeのコード値に対応した作業の種類を定数に持つ，Type列挙型を返します。

引数

fromTypeCodeの引数を次の表に示します。

表7‒67　fromTypeCodeの引数（CIWWorkItem.Typeの場合）

仮引数名

名称

in/out

説明

aCode

Type列挙型のTypeのコード値

in

取得したいType列挙型のTypeのコード値を指定します。

戻り値

Typeのコード値に対応する種類を定数に持つType列挙型を返します。

例外

fromTypeCodeで発生する例外を次の表に示します。

表7‒68　fromTypeCodeで発生する例外（CIWWorkItem.Typeの場合）

発生する例外

説明

CIWFatalException

処理を続行できない障害が発生した場合

注意事項

Typeのコード値に「z」または存在しないコードを指定した場合は，例外（CIWFatalException）が発生します。

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

toString

列挙型：CIWWorkItem.Type

構文

public final java.lang.String toString()

機能

作業の種類の文字列表現を取得します。

表示形式は，「種類の定数（種類のWorkTypeCodeの値）」となります。

引数

ありません。

オーバーライド

java.lang.Enum<CIWWorkItem.Type>クラス内のtoString

戻り値

作業の種類の文字列表現を返します。

例外

ありません。

注意事項

作業の種類の文字列表現については，「付録B　参照系APIで指定できる属性」を参照してください。

toType

列挙型：CIWWorkItem.Type

構文

public final java.lang.String toType()

機能

作業の種類を示すTypeの完全表記形式を取得します。

引数

ありません。

戻り値

Typeの完全表記形式を返します。

例外

ありません。

注意事項

Typeの完全表記形式については，「付録B　参照系APIで指定できる属性」を参照してください。

toTypeCode

列挙型：CIWWorkItem.Type

構文

public final java.lang.String toTypeCode()

機能

作業の種類を示すTypeのコード値を取得します。

引数

ありません。

戻り値

Typeのコード値を返します。

例外

ありません。

注意事項

Typeのコード値については，「付録B　参照系APIで指定できる属性」を参照してください。

valueOf

列挙型：CIWWorkItem.Type

構文

public static CIWWorkItem.Type valueOf(
     java.lang.String name
)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表7‒69　valueOfの引数（CIWWorkItem.Typeの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表7‒70　valueOfで発生する例外（CIWWorkItem.Typeの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkItem.Type

構文

public static final CIWWorkItem.Type[]
     values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkItem.Type c :
CIWWorkItem.Type.values())
     System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

8　例外クラス

この章では，パッケージ「jp.co.Hitachi.soft.csciw」に所属するAPIの，クラスおよびインタフェース使用時にスローされる例外クラスについて説明します。なお，例外クラスの階層については，「3.3　パッケージ「jp.co.Hitachi.soft.csciw」の階層」を参照してください。

8.1　記述形式

8.1.1　例外クラスの記述形式

例外クラスは，次に示す形式を基本として説明しています。

クラス定義

APIのクラス定義を示します。

すべての実装されたインタフェース

APIのすべての実装されたインタフェースを示します。

直系の既知のサブクラス

API直系の既知のサブクラスを示します。

メソッド

APIのメソッドを説明します。

8.1.2　例外クラスが提供するメソッドの記述形式

例外クラスが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名

メソッドが所属するクラス名を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

オーバーライド

メソッドのオーバーライドを説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

8.2　CIWEntityNotExistException（処理するオブジェクトが存在しない場合）

処理しようとしたオブジェクトが存在しない場合にスローされる例外クラスです。

オブジェクトを取得したあとに，ほかから操作されてワーク管理データベース上に存在しなくなったり，IDを指定するメソッドで不正なIDが指定されたりした場合に発生します。

クラス定義

public final class CIWEntityNotExistException
     extends CIWException

すべての実装されたインタフェース

java.io.Serializable

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

8.3　CIWException（例外の基底の抽象クラス）

CSCIWで発生する例外の基底となる抽象クラスです。

クラス定義

public abstract class CIWException
     extends java.lang.Exception

すべての実装されたインタフェース

java.io.Serializable

直系の既知のサブクラス

CIWException直系の既知のサブクラスを次の表に示します。

表8‒1　CIWException直系の既知のサブクラス

サブクラス名

説明

CIWEntityNotExistException

処理しようとしたオブジェクトが存在しない場合にスローされる例外クラスです。

CIWFatalException

処理を続行できないような障害が発生した場合にスローされる例外クラスです。

CIWStateException

不正な状態に関する例外クラスです。

CIWTransientException

一時的な要因で処理を実行できない場合にスローされる例外クラスです。

CIWTransitionFailedException

案件処理中にエラーが発生した場合にスローされる例外クラスです。

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

8.4　CIWFatalException（障害発生の場合）

処理を続行できないような障害が発生した場合にスローされる例外クラスです。

クラス定義

public class CIWFatalException
     extends CIWException

すべての実装されたインタフェース

java.io.Serializable

直系の既知のサブクラス

CIWFatalException直系の既知のサブクラスを次の表に示します。

表8‒2　CIWFatalException直系の既知のサブクラス

サブクラス名

説明

CIWSQLException

DBMSで処理を続行できないような障害が発生した場合にスローされる例外クラスです。

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

8.5　CIWSQLException（DBMSの障害発生の場合）

DBMSで処理を続行できないような障害が発生した場合にスローされる例外クラスです。

クラス定義

public final class CIWSQLException
     extends CIWFatalException

すべての実装されたインタフェース

java.io.Serializable

メソッド

CIWSQLExceptionのメソッドを次の表に示します。

表8‒3　CIWSQLExceptionのメソッド

メソッド名

説明

getCause

原因のSQLExceptionを取得します。

getErrorCode

ベンダー固有の例外コードを取得します。

getSQLState

SQLState値を取得します。

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

getCause

クラス名：CIWSQLException

構文

public java.sql.SQLException getCause()

機能

原因のSQLExceptionを取得します。

オーバーライド

java.lang.Throwableクラス内のgetCause

引数

ありません。

戻り値

原因となるSQLExceptionを返します。

getErrorCode

クラス名：CIWSQLException

構文

public int getErrorCode()

機能

ベンダー固有の例外コードを取得します。

引数

ありません。

戻り値

ベンダー固有の例外コードを返します。

getSQLState

クラス名：CIWSQLException

構文

public java.lang.String getSQLState()

機能

SQLState値を取得します。

引数

ありません。

戻り値

SQLState値を返します。

8.6　CIWSQLTransientException（DBMSの一時的な障害発生の場合）

DBMSの一時的な要因で処理を実行できない場合にスローされる例外クラスです。

セットアッププロパティファイルの設定項目の，次のどれかにSQL例外となるSQLCODEまたはSQLSTATEの値が設定された場合に，この例外がスローされます。

HiRDBTransientSQLCode

HiRDBTransientSQLState

OracleTransientSQLCode

OracleTransientSQLState

SQLServerTransientSQLCode

SQLServerTransientSQLState

セットアッププロパティファイルについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」の「環境設定ファイル」を参照してください。

クラス定義

public final class CIWSQLTransientException
     extends CIWTransientException

すべての実装されたインタフェース

java.io.Serializable

メソッド

CIWSQLTransientExceptionのメソッドを次の表に示します。

表8‒4　CIWSQLTransientExceptionのメソッド

メソッド

機能概要

getCause

原因のSQLExceptionを取得します。

getErrorCode

ベンダー固有の例外コードを取得します。

getSQLState

SQLState値を取得します。

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

getCause

クラス名：CIWSQLTransientException

構文

public java.sql.SQLException getCause()

機能

原因のSQLExceptionを取得します。

オーバーライド

java.lang.Throwableクラス内のgetCause

引数

ありません。

戻り値

原因となるSQLExceptionを返します。

getErrorCode

クラス名：CIWSQLTransientException

構文

public int getErrorCode()

機能

ベンダー固有の例外コードを取得します。

引数

ありません。

戻り値

ベンダー固有の例外コードを返します。

getSQLState

クラス名：CIWSQLTransientException

構文

public java.lang.String getSQLState()

機能

SQLState値を取得します。

引数

ありません。

戻り値

SQLState値を返します。

8.7　CIWStateException（不正な状態の場合）

不正な状態に関する例外クラスです。

クラス定義

public final class CIWStateException
     extends CIWException

すべての実装されたインタフェース

java.io.Serializable

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

8.8　CIWTransientException（一時的な障害発生の場合）

一時的な要因で処理を実行できない場合にスローされる例外クラスです。

クラス定義

public class CIWTransientException
     extends CIWException

すべての実装されたインタフェース

java.io.Serializable

直系の既知のサブクラス

CIWTransientException直系の既知のサブクラスを次の表に示します。

表8‒5　CIWTransientException直系の既知のサブクラス

サブクラス名

説明

CIWSQLTransientException

DBMSの一時的な要因で処理を実行できない場合にスローされる例外クラスです。

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

8.9　CIWTransitionFailedException（案件処理中のエラーの場合）

案件処理中にエラーが発生した場合にスローされる例外クラスです。

クラス定義

public final class CIWTransitionFailedException
     extends CIWException

すべての実装されたインタフェース

java.io.Serializable

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace，getCause，getLocalizedMessage，getMessage，getStackTrace，initCause，printStackTrace，printStackTrace，printStackTrace，setStackTrace，toString

java.lang.Objectクラスから継承されたメソッド

clone，equals，finalize，getClass，hashCode，notify，notifyAll，wait，wait，wait

第3編　リファレンス編（パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属するAPI）

9　Javaオブジェクト呼び出し用のインタフェース

この章では，Javaオブジェクト呼び出し用のインタフェースについて説明します。

このマニュアルでは，条件，振り分けルール，生成ルール，および作業アプリケーションのJavaオブジェクト呼び出し機能について説明します。

アプリケーション呼び出しサービスのJavaオブジェクト呼び出し機能については，マニュアル「uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引」を参照してください。

9.1　記述形式

Javaオブジェクト呼び出し用のインタフェースの記述形式について説明します。

9.1.1　条件またはルールの評価・作業アプリケーション用クラスおよびインタフェースの記述形式

入れ子のクラス

インタフェースの入れ子のクラスを説明します。

メソッド

メソッドを説明します。

9.1.2　条件またはルールの評価・作業アプリケーション用クラスおよびインタフェースが提供するメソッドの記述形式

条件またはルールの評価・作業アプリケーション用クラスおよびインタフェースが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名またはインタフェース名

メソッドが所属するクラス名またはインタフェース名を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

9.2　CIWConditionEvaluator（条件Javaオブジェクトのインタフェース）

条件Javaオブジェクトのインタフェースです。

入れ子のクラス

CIWConditionEvaluatorの入れ子のクラスを次の表に示します。

表9‒1　CIWConditionEvaluatorの入れ子のクラス

クラス名

入れ子のクラスの説明およびクラスの記述形式

CIWConditionEvaluator.Parameter

条件に渡されるパラメタの列挙型です。

static class CIWConditionEvaluator.Parameter

メソッド

CIWConditionEvaluatorインタフェースのメソッドを次の表に示します。

表9‒2　CIWConditionEvaluatorインタフェースのメソッド

メソッド名

説明

evaluateCondition

条件を評価し，評価結果を取得します。

evaluateCondition

インタフェース名：CIWConditionEvaluator

構文

boolean evaluateCondition(java.util.Map<CIWConditionEvaluator.Parameter,java.lang.String> aParameters,
                  java.sql.Connection aDBConnection)
                  throws CIWUserException

機能

条件を評価し，評価結果を取得します。

引数

evaluateConditionの引数を次の表に示します。

表9‒3　evaluateConditionの引数

仮引数名

名称

IN/OUT

説明

aParameters

Javaオブジェクトに渡されるパラメタ一覧

IN

Parameter列挙型をキーに値を取得します。値が設定されていない場合，nullが取得されます。

Javaオブジェクトに渡されるパラメタ一覧については，「2.6.4　業務プログラムに渡される情報」を参照してください。

aDBConnection

CSCIWに関連づけられたコネクション

IN

このコネクションを使用することで，CSCIWのシステムと同一のトランザクションでデータベースにアクセスできます。

戻り値

条件を満たしている場合はtrueを返してください。

条件を満たしていない場合はfalseを返してください。

例外

evaluateConditionでエラーを検出した場合は，CIWUserExceptionをスローしてください。

注意事項

このメソッド内ではCSCIWのAPIを実行できません。

例外をスローした場合は，業務アプリケーションで例外（CIWTransitionFailedException）が発生します。

aDBConnectionのコネクションを切断したり，トランザクションを終了したりしないでください。

9.3　CIWCreationRuleEvaluator（生成ルールJavaオブジェクトのインタフェース）

生成ルールJavaオブジェクトのインタフェースです。

入れ子のクラス

CIWCreationRuleEvaluatorの入れ子のクラスを次の表に示します。

表9‒4　CIWCreationRuleEvaluatorの入れ子のクラス

クラス名

入れ子のクラスの説明およびクラスの記述形式

CIWCreationRuleEvaluator.Parameter

生成ルールに渡されるパラメタの列挙型です。

static class CIWCreationRuleEvaluator.Parameter

メソッド

CIWCreationRuleEvaluatorインタフェースのメソッドを次の表に示します。

表9‒5　CIWCreationRuleEvaluatorインタフェースのメソッド

メソッド名

説明

evaluateCreationRule

生成ルールを評価し，子作業名を取得します。

evaluateCreationRule

インタフェース名：CIWCreationRuleEvaluator

構文

java.util.Set<java.lang.String> evaluateCreationRule(java.util.Map<CIWCreationRuleEvaluator.Parameter,java.lang.String> aParameters,
                     java.sql.Connection aDBConnection)
                     throws CIWUserException

機能

生成ルールを評価し，子作業名を取得します。

引数

evaluateCreationRuleの引数を次の表に示します。

表9‒6　evaluateCreationRuleの引数

仮引数名

名称

IN/OUT

説明

aParameters

Javaオブジェクトに渡されるパラメタ一覧

IN

Parameter列挙型をキーに値を取得します。値が設定されていない場合，nullが取得されます。

Javaオブジェクトに渡されるパラメタ一覧については，「2.6.4　業務プログラムに渡される情報」を参照してください。

aDBConnection

CSCIWに関連づけられたコネクション

IN

このコネクションを使用することで，CSCIWのシステムと同一のトランザクションでデータベースにアクセスできます。

戻り値

子作業の作業名Setを返してください。

例外

evaluateCreationRuleでエラーを検出した場合は，CIWUserExceptionをスローしてください。

注意事項

このメソッド内ではCSCIWのAPIを実行できません。

戻り値に要素数0のSetを指定すると，子作業は生成されません。

次の場合は業務アプリケーションで例外（CIWTransitionFailedException）が発生します。

戻り値にnullを指定した場合

戻り値に1バイト以上，<SYSTEMID>_WORK_ITEMテーブルのNameカラムのバイト数未満の作業名を指定しなかった場合

例外をスローした場合

aDBConnectionのコネクションを切断したり，トランザクションを終了したりしないでください。

9.4　CIWResourceSelector（振り分けルールJavaオブジェクトのインタフェース）

振り分けルールJavaオブジェクトのインタフェースです。

入れ子のクラス

CIWResourceSelectorの入れ子のクラスを次の表に示します。

表9‒7　CIWResourceSelectorの入れ子のクラス

クラス名

入れ子のクラスの説明およびクラスの記述形式

CIWResourceSelector.Parameter

振り分けルールに渡されるパラメタの列挙型です。

static class CIWResourceSelector.Parameter

メソッド

CIWResourceSelectorインタフェースのメソッドを次の表に示します。

表9‒8　CIWResourceSelectorインタフェースのメソッド

メソッド名

説明

getAvailableParticipant

振り分けルールを評価し，作業者IDを取得します。

getAvailableParticipant

インタフェース名：CIWResourceSelector

構文

java.lang.String getAvailableParticipant(java.util.Map<CIWResourceSelector.Parameter,java.lang.String> aParameters,
                        java.sql.Connection aDBConnection)
                        throws CIWUserException

機能

振り分けルールを評価し，作業者IDを取得します。

引数

getAvailableParticipantの引数を次の表に示します。

表9‒9　getAvailableParticipantの引数

仮引数名

名称

IN/OUT

説明

aParameters

Javaオブジェクトに渡されるパラメタ一覧

IN

Parameter列挙型をキーに値を取得します。値が設定されていない場合，nullが取得されます。

Javaオブジェクトに渡されるパラメタ一覧については，「2.6.4　業務プログラムに渡される情報」を参照してください。

aDBConnection

CSCIWに関連づけられたコネクション

IN

このコネクションを使用することで，CSCIWのシステムと同一のトランザクションでデータベースにアクセスできます。

戻り値

作業者IDを返してください。

例外

getAvailableParticipantでエラーを検出した場合は，CIWUserExceptionをスローしてください。

注意事項

このメソッド内ではCSCIWのAPIを実行できません。

次の場合は業務アプリケーションで例外（CIWTransitionFailedException）が発生します。

戻り値にnullを指定した場合

戻り値に1バイト以上，<SYSTEMID>_WORK_ITEMテーブルのParticipantカラムのバイト数未満の作業者IDを指定しなかった場合

例外をスローした場合

aDBConnectionのコネクションを切断したり，トランザクションを終了したりしないでください。

9.5　CIWWorkApplication（作業アプリケーションJavaオブジェクトのインタフェース）

作業アプリケーションJavaオブジェクトのインタフェースです。

入れ子のクラス

CIWWorkApplicationの入れ子のクラスを次の表に示します。

表9‒10　CIWWorkApplicationの入れ子のクラス

クラス名

入れ子のクラスの説明およびクラスの記述形式

CIWWorkApplication.Parameter

作業アプリケーションに渡されるパラメタの列挙型です。

static class CIWWorkApplication.Parameter

CIWWorkApplication.Result

作業アプリケーションの業務処理結果の列挙型です。

static class CIWWorkApplication.Result

メソッド

CIWWorkApplicationインタフェースのメソッドを次の表に示します。

表9‒11　CIWWorkApplicationインタフェースのメソッド

メソッド名

説明

startSynchronously

作業アプリケーションを同期処理で開始します。

startSynchronously

インタフェース名：CIWWorkApplication

構文

CIWWorkApplication.Result startSynchronously(java.util.Map<CIWWorkApplication.Parameter,java.lang.String> aParameters,
                   java.sql.Connection aDBConnection)
                   throws CIWUserException

機能

作業アプリケーションを同期処理で開始します。

引数

startSynchronouslyの引数を次の表に示します。

表9‒12　startSynchronouslyの引数

仮引数名

名称

IN/OUT

説明

aParameters

Javaオブジェクトに渡されるパラメタ一覧

IN

Parameter列挙型をキーに値を取得します。値が設定されていない場合，nullが取得されます。

Javaオブジェクトに渡されるパラメタ一覧については，「2.6.4　業務プログラムに渡される情報」を参照してください。

aDBConnection

CSCIWに関連づけられたコネクション

IN

このコネクションを使用することで，CSCIWのシステムと同一のトランザクションでデータベースにアクセスできます。

戻り値

作業の状態を変更しない場合はResult.NO_CHANGE_STATEを返してください。

作業を着手する場合はResult.PERFORMを返してください。

作業を完了する場合はResult.PERFORM_AND_COMPLETEを返してください。

例外

startSynchronouslyでエラーを検出した場合は，CIWUserExceptionをスローしてください。

注意事項

このメソッド内ではCSCIWのAPIを実行できません。

次の場合は業務アプリケーションで例外（CIWTransitionFailedException）が発生します。

戻り値にnullを指定した場合

例外をスローした場合

aDBConnectionのコネクションを切断したり，トランザクションを終了したりしないでください。

10　列挙型

この章では，パッケージ「jp.co.Hitachi.soft.csciw.callback」が提供する列挙型について説明します。

10.1　記述形式

10.1.1　列挙型の記述形式

列挙型は，次に示す形式を基本として説明しています。

概要

列挙型の概要を説明します。

定義

列挙型の定義を示します。

すべての実装されたインタフェース

列挙型のすべての実装されたインタフェースを示します。

含まれているインタフェース

列挙型の含まれているインタフェースを示します。

定数

列挙型の定数を説明します。

メソッド

列挙型のメソッドを説明します。

10.1.2　列挙型が提供するメソッドの記述形式

列挙型が提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

列挙型

メソッドが所属する列挙型を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

例外

メソッドに発生する例外を説明します。

注意事項

メソッドの注意事項を説明します。

10.2　CIWConditionEvaluator.Parameter（条件に渡されるパラメタの列挙型）

概要

条件に渡されるパラメタの列挙型です。

定義

public static enum CIWConditionEvaluator.Parameter extends java.lang.Enum<CIWConditionEvaluator.Parameter>

すべての実装されたインタフェース

java.io.Serializable, java.lang.Comparable<CIWConditionEvaluator.Parameter>

含まれているインタフェース

CIWConditionEvaluator

定数

CIWConditionEvaluator.Parameterの列挙型定数を次の表に示します。

表10‒1　CIWConditionEvaluator.Parameterの列挙型定数

定数名

説明および記述形式

CSCIW_ADEFNAME

業務ステップ定義名

public static final CIWConditionEvaluator.Parameter CSCIW_ADEFNAME

CSCIW_AIDEADLINE

業務ステップ処理期限

public static final CIWConditionEvaluator.Parameter CSCIW_AIDEADLINE

CSCIW_AINAME

業務ステップ名

public static final CIWConditionEvaluator.Parameter CSCIW_AINAME

CSCIW_AIPRIORITY

業務ステップ優先度

public static final CIWConditionEvaluator.Parameter CSCIW_AIPRIORITY

CSCIW_AISTARTDATE

業務ステップ開始日時

public static final CIWConditionEvaluator.Parameter CSCIW_AISTARTDATE

CSCIW_CNDEFNAME

制御ノード定義名

public static final CIWConditionEvaluator.Parameter CSCIW_CNDEFNAME

CSCIW_EXPARAMETER

補助定数パラメタ

public static final CIWConditionEvaluator.Parameter CSCIW_EXPARAMETER

CSCIW_PDEFNAME

ビジネスプロセス定義名

public static final CIWConditionEvaluator.Parameter CSCIW_PDEFNAME

CSCIW_PDEFVERSION

ビジネスプロセス定義のバージョン

public static final CIWConditionEvaluator.Parameter CSCIW_PDEFVERSION

CSCIW_PICREATOR

案件投入者

public static final CIWConditionEvaluator.Parameter CSCIW_PICREATOR

CSCIW_PIDEADLINE

案件処理期限

public static final CIWConditionEvaluator.Parameter CSCIW_PIDEADLINE

CSCIW_PIID

案件ID

public static final CIWConditionEvaluator.Parameter CSCIW_PIID

CSCIW_PINAME

案件名

public static final CIWConditionEvaluator.Parameter CSCIW_PINAME

CSCIW_PIPRIORITY

案件優先度

public static final CIWConditionEvaluator.Parameter CSCIW_PIPRIORITY

CSCIW_PISTARTDATE

案件開始日時

public static final CIWConditionEvaluator.Parameter CSCIW_PISTARTDATE

CSCIW_USERID

ユーザ識別子

public static final CIWConditionEvaluator.Parameter CSCIW_USERID

CSCIW_WDEFNAME

作業定義名

public static final CIWConditionEvaluator.Parameter CSCIW_WDEFNAME

CSCIW_WICREATIONDATE

作業生成日時

public static final CIWConditionEvaluator.Parameter CSCIW_WICREATIONDATE

CSCIW_WIDEADLINE

作業期限

public static final CIWConditionEvaluator.Parameter CSCIW_WIDEADLINE

CSCIW_WINAME

作業名

public static final CIWConditionEvaluator.Parameter CSCIW_WINAME

CSCIW_WIPARTICIPANT

作業者

public static final CIWConditionEvaluator.Parameter CSCIW_WIPARTICIPANT

CSCIW_WIPRIORITY

作業優先度

public static final CIWConditionEvaluator.Parameter CSCIW_WIPRIORITY

CSCIW_WISTARTDATE

作業開始日時

public static final CIWConditionEvaluator.Parameter CSCIW_WISTARTDATE

メソッド

CIWConditionEvaluator.Parameterのメソッドを次の表に示します。

表10‒2　CIWConditionEvaluator.Parameterのメソッド

メソッド

説明

toParameterName

パラメタ名を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数を含む配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

java.lang.Objectクラスから継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

toParameterName

列挙型：CIWConditionEvaluator.Parameter

構文

public final java.lang.String toParameterName()

機能

パラメタ名を取得します。

引数

ありません。

戻り値

パラメタ名を返します。

例外

ありません。

valueOf

列挙型：CIWConditionEvaluator.Parameter

構文

public static CIWConditionEvaluator.Parameter valueOf(java.lang.String name)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表10‒3　valueOfの引数（CIWConditionEvaluator.Parameterの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表10‒4　valueOfで発生する例外（CIWConditionEvaluator.Parameterの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWConditionEvaluator.Parameter

構文

public static final CIWConditionEvaluator.Parameter[] values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWConditionEvaluator.Parameter c : CIWConditionEvaluator.Parameter.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

10.3　CIWCreationRuleEvaluator.Parameter（生成ルールに渡されるパラメタの列挙型）

概要

生成ルールに渡されるパラメタの列挙型です。

定義

public static enum CIWCreationRuleEvaluator.Parameter extends java.lang.Enum<CIWCreationRuleEvaluator.Parameter>

すべての実装されたインタフェース

java.io.Serializable, java.lang.Comparable<CIWCreationRuleEvaluator.Parameter>

含まれているインタフェース

CIWCreationRuleEvaluator

定数

CIWCreationRuleEvaluator.Parameterの列挙型定数を次の表に示します。

表10‒5　CIWCreationRuleEvaluator.Parameterの列挙型定数

定数名

説明および記述形式

CSCIW_ADEFNAME

業務ステップ定義名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_ADEFNAME

CSCIW_AIDEADLINE

業務ステップ処理期限

public static final CIWCreationRuleEvaluator.Parameter CSCIW_AIDEADLINE

CSCIW_AINAME

業務ステップ名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_AINAME

CSCIW_AIPRIORITY

業務ステップ優先度

public static final CIWCreationRuleEvaluator.Parameter CSCIW_AIPRIORITY

CSCIW_AISTARTDATE

業務ステップ開始日時

public static final CIWCreationRuleEvaluator.Parameter CSCIW_AISTARTDATE

CSCIW_EXPARAMETER

補助定数パラメタ

public static final CIWCreationRuleEvaluator.Parameter CSCIW_EXPARAMETER

CSCIW_PDEFNAME

ビジネスプロセス定義名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PDEFNAME

CSCIW_PDEFVERSION

ビジネスプロセス定義のバージョン

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PDEFVERSION

CSCIW_PICREATOR

案件投入者

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PICREATOR

CSCIW_PIDEADLINE

案件処理期限

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PIDEADLINE

CSCIW_PIID

案件ID

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PIID

CSCIW_PINAME

案件名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PINAME

CSCIW_PIPRIORITY

案件優先度

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PIPRIORITY

CSCIW_PISTARTDATE

案件開始日時

public static final CIWCreationRuleEvaluator.Parameter CSCIW_PISTARTDATE

CSCIW_USERID

ユーザ識別子

public static final CIWCreationRuleEvaluator.Parameter CSCIW_USERID

CSCIW_WDEFNAME

作業定義名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WDEFNAME

CSCIW_WICREATIONDATE

作業生成日時

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WICREATIONDATE

CSCIW_WIDEADLINE

作業期限

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WIDEADLINE

CSCIW_WINAME

作業名

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WINAME

CSCIW_WIPARTICIPANT

作業者

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WIPARTICIPANT

CSCIW_WIPRIORITY

作業優先度

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WIPRIORITY

CSCIW_WISTARTDATE

作業開始日時

public static final CIWCreationRuleEvaluator.Parameter CSCIW_WISTARTDATE

メソッド

CIWCreationRuleEvaluator.Parameterのメソッドを次の表に示します。

表10‒6　CIWCreationRuleEvaluator.Parameterのメソッド

メソッド

説明

toParameterName

パラメタ名を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数を含む配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

java.lang.Objectクラスから継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

toParameterName

列挙型：CIWCreationRuleEvaluator.Parameter

構文

public final java.lang.String toParameterName()

機能

パラメタ名を取得します。

引数

ありません。

戻り値

パラメタ名を返します。

例外

ありません。

valueOf

列挙型：CIWCreationRuleEvaluator.Parameter

構文

public static CIWCreationRuleEvaluator.Parameter valueOf(java.lang.String name)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表10‒7　valueOfの引数（CIWCreationRuleEvaluator.Parameterの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表10‒8　valueOfで発生する例外（CIWCreationRuleEvaluator.Parameterの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWCreationRuleEvaluator.Parameter

構文

public static final CIWCreationRuleEvaluator.Parameter[] values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWCreationRuleEvaluator.Parameter c : CIWCreationRuleEvaluator.Parameter.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

10.4　CIWResourceSelector.Parameter（振り分けルールに渡されるパラメタの列挙型）

概要

振り分けルールに渡されるパラメタの列挙型です。

定義

public static enum CIWResourceSelector.Parameter extends java.lang.Enum<CIWResourceSelector.Parameter>

すべての実装されたインタフェース

java.io.Serializable, java.lang.Comparable<CIWResourceSelector.Parameter>

含まれているインタフェース

CIWResourceSelector

定数

CIWResourceSelector.Parameterの列挙型定数を次の表に示します。

表10‒9　CIWResourceSelector.Parameterの列挙型定数

定数

説明および記述形式

CSCIW_ADEFNAME

業務ステップ定義名

public static final CIWResourceSelector.Parameter CSCIW_ADEFNAME

CSCIW_AIDEADLINE

業務ステップ処理期限

public static final CIWResourceSelector.Parameter CSCIW_AIDEADLINE

CSCIW_AINAME

業務ステップ名

public static final CIWResourceSelector.Parameter CSCIW_AINAME

CSCIW_AIPRIORITY

業務ステップ優先度

public static final CIWResourceSelector.Parameter CSCIW_AIPRIORITY

CSCIW_AISTARTDATE

業務ステップ開始日時

public static final CIWResourceSelector.Parameter CSCIW_AISTARTDATE

CSCIW_EXPARAMETER

補助定数パラメタ

public static final CIWResourceSelector.Parameter CSCIW_EXPARAMETER

CSCIW_PDEFNAME

ビジネスプロセス定義名

public static final CIWResourceSelector.Parameter CSCIW_PDEFNAME

CSCIW_PDEFVERSION

ビジネスプロセス定義のバージョン

public static final CIWResourceSelector.Parameter CSCIW_PDEFVERSION

CSCIW_PICREATOR

案件投入者

public static final CIWResourceSelector.Parameter CSCIW_PICREATOR

CSCIW_PIDEADLINE

案件処理期限

public static final CIWResourceSelector.Parameter CSCIW_PIDEADLINE

CSCIW_PIID

案件ID

public static final CIWResourceSelector.Parameter CSCIW_PIID

CSCIW_PINAME

案件名

public static final CIWResourceSelector.Parameter CSCIW_PINAME

CSCIW_PIPRIORITY

案件優先度

public static final CIWResourceSelector.Parameter CSCIW_PIPRIORITY

CSCIW_PISTARTDATE

案件開始日時

public static final CIWResourceSelector.Parameter CSCIW_PISTARTDATE

CSCIW_USERID

ユーザ識別子

public static final CIWResourceSelector.Parameter CSCIW_USERID

CSCIW_WDEFNAME

作業定義名

public static final CIWResourceSelector.Parameter CSCIW_WDEFNAME

CSCIW_WICREATIONDATE

作業生成日時

public static final CIWResourceSelector.Parameter CSCIW_WICREATIONDATE

CSCIW_WIDEADLINE

作業期限

public static final CIWResourceSelector.Parameter CSCIW_WIDEADLINE

CSCIW_WINAME

作業名

public static final CIWResourceSelector.Parameter CSCIW_WINAME

CSCIW_WIPARTICIPANT

作業者

public static final CIWResourceSelector.Parameter CSCIW_WIPARTICIPANT

CSCIW_WISTARTDATE

作業開始日時

public static final CIWResourceSelector.Parameter CSCIW_WISTARTDATE

メソッド

CIWResourceSelector.Parameterのメソッドを次の表に示します。

表10‒10　CIWResourceSelector.Parameterのメソッド

メソッド

説明

toParameterName

パラメタ名を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数を含む配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

java.lang.Objectクラスから継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

toParameterName

列挙型：CIWResourceSelector.Parameter

構文

public final java.lang.String toParameterName()

機能

パラメタ名を取得します。

引数

ありません。

戻り値

パラメタ名を返します。

例外

ありません。

valueOf

列挙型：CIWResourceSelector.Parameter

構文

public static CIWResourceSelector.Parameter valueOf(java.lang.String name)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表10‒11　valueOfの引数（CIWResourceSelector.Parameterの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表10‒12　valueOfで発生する例外（CIWResourceSelector.Parameterの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWResourceSelector.Parameter

構文

public static final CIWResourceSelector.Parameter[] values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWResourceSelector.Parameter c : CIWResourceSelector.Parameter.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

10.5　CIWWorkApplication.Parameter（作業アプリケーションに渡されるパラメタの列挙型）

概要

作業アプリケーションに渡されるパラメタの列挙型です。

定義

public static enum CIWWorkApplication.Parameter extends java.lang.Enum<CIWWorkApplication.Parameter>

すべての実装されたインタフェース

java.io.Serializable, java.lang.Comparable<CIWWorkApplication.Parameter>

含まれているインタフェース

CIWWorkApplication

定数

CIWWorkApplication.Parameterの列挙型定数を次の表に示します。

表10‒13　CIWWorkApplication.Parameterの列挙型定数

定数名

説明および記述形式

CSCIW_ADEFNAME

業務ステップ定義名

public static final CIWWorkApplication.Parameter CSCIW_ADEFNAME

CSCIW_AIDEADLINE

業務ステップ処理期限

public static final CIWWorkApplication.Parameter CSCIW_AIDEADLINE

CSCIW_AINAME

業務ステップ名

public static final CIWWorkApplication.Parameter CSCIW_AINAME

CSCIW_AIPRIORITY

業務ステップ優先度

public static final CIWWorkApplication.Parameter CSCIW_AIPRIORITY

CSCIW_AISTARTDATE

業務ステップ開始日時

public static final CIWWorkApplication.Parameter CSCIW_AISTARTDATE

CSCIW_EXPARAMETER

補助定数パラメタ

public static final CIWWorkApplication.Parameter CSCIW_EXPARAMETER

CSCIW_PDEFNAME

ビジネスプロセス定義名

public static final CIWWorkApplication.Parameter CSCIW_PDEFNAME

CSCIW_PDEFVERSION

ビジネスプロセス定義のバージョン

public static final CIWWorkApplication.Parameter CSCIW_PDEFVERSION

CSCIW_PICREATOR

案件投入者

public static final CIWWorkApplication.Parameter CSCIW_PICREATOR

CSCIW_PIDEADLINE

案件処理期限

public static final CIWWorkApplication.Parameter CSCIW_PIDEADLINE

CSCIW_PIID

案件ID

public static final CIWWorkApplication.Parameter CSCIW_PIID

CSCIW_PINAME

案件名

public static final CIWWorkApplication.Parameter CSCIW_PINAME

CSCIW_PIPRIORITY

案件優先度

public static final CIWWorkApplication.Parameter CSCIW_PIPRIORITY

CSCIW_PISTARTDATE

案件開始日時

public static final CIWWorkApplication.Parameter CSCIW_PISTARTDATE

CSCIW_SYSTEMID

システムID

public static final CIWWorkApplication.Parameter CSCIW_SYSTEMID

CSCIW_USERID

ユーザ識別子

public static final CIWWorkApplication.Parameter CSCIW_USERID

CSCIW_WDEFNAME

作業定義名

public static final CIWWorkApplication.Parameter CSCIW_WDEFNAME

CSCIW_WICREATIONDATE

作業生成日時

public static final CIWWorkApplication.Parameter CSCIW_WICREATIONDATE

CSCIW_WIDEADLINE

作業処理期限

public static final CIWWorkApplication.Parameter CSCIW_WIDEADLINE

CSCIW_WINAME

作業名

public static final CIWWorkApplication.Parameter CSCIW_WINAME

CSCIW_WIPARTICIPANT

作業者

public static final CIWWorkApplication.Parameter CSCIW_WIPARTICIPANT

CSCIW_WIPRIORITY

作業優先度

public static final CIWWorkApplication.Parameter CSCIW_WIPRIORITY

CSCIW_WISTARTDATE

作業開始日時

public static final CIWWorkApplication.Parameter CSCIW_WISTARTDATE

メソッド

CIWWorkApplication.Parameterのメソッドを次の表に示します。

表10‒14　CIWWorkApplication.Parameterのメソッド

メソッド

説明

toParameterName

パラメタ名を取得します。

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数を含む配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

java.lang.Objectクラスから継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

toParameterName

列挙型：CIWWorkApplication.Parameter

構文

public final java.lang.String toParameterName()

機能

パラメタ名を取得します。

引数

ありません。

戻り値

パラメタ名を返します。

例外

ありません。

valueOf

列挙型：CIWWorkApplication.Parameter

構文

public static CIWWorkApplication.Parameter valueOf(java.lang.String name)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表10‒15　valueOfの引数（CIWWorkApplication.Parameterの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表10‒16　valueOfで発生する例外（CIWWorkApplication.Parameterの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkApplication.Parameter

構文

public static final CIWWorkApplication.Parameter[] values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkApplication.Parameter c : CIWWorkApplication.Parameter.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

10.6　CIWWorkApplication.Result（作業アプリケーションの業務処理結果の列挙型）

概要

作業アプリケーションの業務処理結果の列挙型です。

定義

public static enum CIWWorkApplication.Result extends java.lang.Enum<CIWWorkApplication.Result>

すべての実装されたインタフェース

java.io.Serializable, java.lang.Comparable<CIWWorkApplication.Result>

含まれているインタフェース

CIWWorkApplication

定数

CIWWorkApplication.Resultの列挙型定数を次の表に示します。

表10‒17　CIWWorkApplication.Resultの列挙型定数

定数名

説明および記述形式

NO_CHANGE_STATE

作業の状態を変更しない。

public static final CIWWorkApplication.Result NO_CHANGE_STATE

PERFORM

作業を着手する。

public static final CIWWorkApplication.Result PERFORM

PERFORM_AND_COMPLETE

作業を完了する。

public static final CIWWorkApplication.Result PERFORM_AND_COMPLETE

メソッド

CIWWorkApplication.Resultのメソッドを次の表に示します。

表10‒18　CIWWorkApplication.Resultのメソッド

メソッド

説明

valueOf

指定した名前を持つこの型の列挙型定数を返します。

values

この列挙型の定数を含む配列を宣言されている順序で返します。

java.lang.Enumクラスから継承されたメソッド

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

java.lang.Objectクラスから継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

valueOf

列挙型：CIWWorkApplication.Result

構文

public static CIWWorkApplication.Result valueOf(java.lang.String name)

機能

指定した名前を持つこの型の列挙型定数を返します。

文字列は，この型の列挙型定数を宣言するのに使用した識別子と完全に一致している必要があります。余分な空白文字を含めることはできません。

引数

valueOfの引数を次の表に示します。

表10‒19　valueOfの引数（CIWWorkApplication.Resultの場合）

仮引数名

名称

in/out

説明

name

列挙型定数の名前

in

返される列挙型定数の名前を指定します。

戻り値

指定された名前を持つ列挙型定数を返します。

例外

valueOfで発生する例外を次の表に示します。

表10‒20　valueOfで発生する例外（CIWWorkApplication.Resultの場合）

発生する例外

説明

java.lang.IllegalArgumentException

指定された名前を持つ定数をこの列挙型が持っていない場合

values

列挙型：CIWWorkApplication.Result

構文

public static final CIWWorkApplication.Result[] values()

機能

この列挙型の定数が含まれている配列を宣言されている順序で返します。

このメソッドは次のようにして定数を繰り返すために使用できます。

for(CIWWorkApplication.Result c :
CIWWorkApplication.Result.values())
        System.out.println(c);

引数

ありません。

戻り値

この列挙型の定数が含まれている配列を宣言されている順序で返します。

例外

ありません。

11　例外クラス

この章では，パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属するAPIの，クラスおよびインタフェース使用時にスローされる例外クラスについて説明します。なお，例外クラスの階層については，「3.4　パッケージ「jp.co.Hitachi.soft.csciw.callback」の階層」を参照してください。

11.1　記述形式

11.1.1　例外クラスの記述形式

例外クラスは，次に示す形式を基本として説明しています。

クラス定義

APIのクラス定義を示します。

すべての実装されたインタフェース

APIのすべての実装されたインタフェースを示します。

メソッド

APIのメソッドを説明します。

11.1.2　例外クラスが提供するメソッドの記述形式

例外クラスが提供するメソッドは，次に示す形式を基本として説明しています。

メソッド名

メソッド名を示します。

クラス名

メソッドが所属するクラス名を示します。

構文

メソッドの構文を示します。

機能

メソッドの機能を説明します。

引数

メソッドの引数を説明します。

戻り値

メソッドが返す戻り値を示します。

11.1.3　例外クラスが提供するコンストラクタの記述形式

例外クラスが提供するコンストラクタは，次に示す形式を基本として説明しています。

コンストラクタ名

コンストラクタ名を示します。

構文

コンストラクタの構文を示します。

機能

コンストラクタの機能を説明します。

引数

コンストラクタの引数を説明します。

11.2　CIWUserException（Javaオブジェクト呼び出し時にエラーが発生した場合）

Javaオブジェクト呼び出し時の例外クラスです。

クラス定義

public final class CIWUserException extends java.lang.Exception

すべての実装されたインタフェース

java.io.Serializable

メソッド

java.lang.Throwableクラスから継承されたメソッド

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

java.lang.Objectクラスから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタ

指定されたユーザエラーメッセージを使用して，例外を作成するコンストラクタ

CIWUserException(java.lang.String aUserErrorMessage)

指定されたユーザエラーメッセージおよびエラー原因を使用して，例外を作成するコンストラクタ

CIWUserException(java.lang.String aUserErrorMessage, java.lang.Throwable initCause)

CIWUserException（ユーザエラーメッセージを使用する場合）

構文

public CIWUserException(java.lang.String aUserErrorMessage)

機能

指定されたユーザエラーメッセージを使用して，Javaオブジェクト呼び出し時の例外を作成します。

引数

CIWUserExceptionの引数を次の表に示します。

表11‒1　CIWUserExceptionの引数（ユーザエラーメッセージを使用する場合）

仮引数名

名称

in/out

説明

aUserErrorMessage

ユーザエラーメッセージ

in

ユーザエラーメッセージを指定します。

指定したエラーメッセージは次のCSCIWのメッセージに出力されます。

条件，生成ルール，および振り分けルールの場合

KDIW02502-E

作業アプリケーションの場合

KDIW05301-E

CSCIWで出力されるメッセージについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow メッセージ」を参照してください。

CIWUserException（ユーザエラーメッセージおよびエラー原因を使用する場合）

構文

public CIWUserException(java.lang.String aUserErrorMessage,
                        java.lang.Throwable initCause)

機能

指定されたユーザエラーメッセージおよびエラー原因を使用して，Javaオブジェクト呼び出し時の例外を作成します。

引数

CIWUserExceptionの引数を次の表に示します。

表11‒2　CIWUserExceptionの引数（ユーザエラーメッセージおよびエラー原因を使用する場合）

仮引数名

名称

in/out

説明

aUserErrorMessage

ユーザエラーメッセージ

in

ユーザエラーメッセージを指定します。

指定したエラーメッセージは次のCSCIWのメッセージに出力されます。

条件，生成ルール，および振り分けルールの場合

KDIW02502-E

作業アプリケーションの場合

KDIW05301-E

CSCIWで出力されるメッセージについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow メッセージ」を参照してください。

initCause

エラー原因

in

エラー原因を指定します。

付録

付録A　更新系APIと参照系API

この節では，CSCIWで使用する更新系APIと参照系APIについて説明します。

付録A.1　更新系API

更新系APIの一覧を次の表に示します。

表A‒1　更新系API一覧

クラス名

API名

説明

CIWServer

createProcessInstance

案件を生成する

createAndStartProcessInstance

案件を生成して開始する

allocateWorkItemEx

条件に一致する作業に作業者を割り当てて着手する

CIWProcessInstance

start

案件を開始する

changeState

案件の状態を変更する

terminate

案件を強制終了する

delete

案件を削除する

setDeadline

案件の処理期限を設定する

setPriority

案件の優先度を設定する

adhocInstantiateActivityInstance

案件の業務ステップを動的に生成する

CIWActivityInstance

changeState

業務ステップの状態を変更する

evaluate

業務ステップの条件を評価する

makeBackwardTransition

業務ステップを差し戻す(引き戻す)

setDeadline

業務ステップの処理期限を設定する

setPriority

業務ステップの優先度を設定する

adhocMakeTransition

業務ステップ間のフロー遷移を実行する

CIWWorkItem

changeState

作業の状態を変更する

perform

作業を開始する

complete

作業を完了する

performAndComplete

作業を開始して完了する

reassign

作業の作業者を変更する

reassignAndPerform

作業の作業者を変更して開始する

evaluate

作業の条件を評価する

reevaluateCastingRule

作業の振り分けルールを再評価する

setDeadline

作業の処理期限を設定する

setPriority

作業の優先度を設定する

free

作業を返却して振り分けルールを再評価する

付録A.2　参照系API

参照系APIの一覧を次の表に示します。

表A‒2　参照系API一覧

クラス名

API名

説明

CIWServer

getProcessInstancesList

指定したフィルター条件を満たした案件リストを取得する

getProcessInstance

指定したIDの案件を取得する

getActivityInstancesList

指定したフィルター条件を満たした業務ステップリストを取得する

getActivityInstance

指定したIDの業務ステップを取得する

getWorkItemsList

指定したフィルター条件を満たした作業リストを取得する

getWorkItem

指定したIDの作業を取得する

getProcessDefinitionsList

指定したフィルター条件を満たしたビジネスプロセス定義リストを取得する

getProcessDefinition

指定したIDのビジネスプロセス定義を取得する

getWorkDefinitionsList

指定したフィルター条件を満たす作業定義リストを取得する

getWorkDefinition

指定したIDの作業定義を取得する

getListCount

指定したフィルター条件を満たす件数を取得する

CIWProcessInstance

getProcessDefinition

対象案件のビジネスプロセス定義を取得する

getWorkItemsList

対象案件に含まれる作業の中で指定したフィルター条件を満たす作業リストを取得する

CIWWorkItem

getParentProcessInstance

対象作業が所属する案件を取得する

getWorkDefinition

対象作業の作業定義を取得する

CIWProcessDefinition

getProcessInstancesList

対象ビジネスプロセス定義を使用している指定したフィルター条件を満たした案件リストを取得する

付録B　参照系APIで指定できる属性

この節では，参照系APIで指定できる属性の範囲について説明します。

付録B.1　指定できる属性一覧

参照系APIの属性リスト，フィルター条件，およびソート条件に指定できる属性の一覧を次に示します。

(1)　ビジネスプロセス定義属性

CIWProcessDefinitionインタフェースのAttributeName列挙型で定義されています。

ビジネスプロセス定義属性を次の表に示します。

表B‒1　ビジネスプロセス定義属性一覧

属性名

列挙値

説明

参照※1

条件※2

インデクス※3

ID

ID

ビジネスプロセス定義ID

○

○

A（U）

Name

NAME

ビジネスプロセス定義名

○

○

B-1（U）

Version

VERSION

ビジネスプロセス定義のバージョン

○

○

B-2（U）

StateCode

STATE

ビジネスプロセス定義の状態

○

○

−

Description

DESCRIPTION

ビジネスプロセス定義の説明

○

○

−

Author

AUTHOR

ビジネスプロセス定義の作成者（上書き時は更新者）

○

○

−

CreationDate

CREATION_DATE

ビジネスプロセス定義の作成日（上書き時は更新日）

○

○

−

Responsible

RESPONSIBLE

ビジネスプロセス定義の管理者ID

○

○

−

ValidFromDate

VALID_FROM_DATE

ビジネスプロセス定義が有効となる日（案件投入可能開始日）

○

○

−

ValidToDate

VALID_TO_DATE

ビジネスプロセス定義が無効となる日（案件投入可能終了日）

○

○

−

（凡例）

○：指定できます。

−：定義されているインデクスがありません。

注※1

属性名セットに指定できるかどうかを示します。

注※2

フィルター条件およびソート条件に指定できるかどうかを示します。

注※3

定義されているインデクスを示します。

英字が各インデクスを示し，「-」に続く数字は，インデクスの構成順序を示します。（U）はユニークインデクスを示します。

(2)　作業定義属性

CIWWorkDefinitionインタフェースのAttributeName列挙型で定義されています。

作業定義属性を次の表に示します。

表B‒2　作業定義属性一覧

属性名

列挙値

説明

参照※1

条件※2

インデクス※3

ID

ID

作業定義のID

○

○

A-2（U），

C（U）

Name

NAME

作業定義の名称

○

○

B

ActivityDefinitionID

ACTIVITY_DEFINITION_ID

作業定義が所属する業務ステップ定義のID

○

○

−

ProcessDefinitionID

PROCESS_DEFINITION_ID

作業定義が所属するビジネスプロセス定義のID

○

○

A-1（U）

WorkTypeCode

TYPE

作業の種類

○

○

−

CastingRuleName

CASTING_RULE_NAME

振り分けルール名

○

○

−

Description

DESCRIPTION

作業の説明

○

○

−

（凡例）

○：指定できます。

−：定義されているインデクスがありません。

注※1

属性名セットに指定できるかどうかを示します。

注※2

フィルター条件およびソート条件に指定できるかどうかを示します。

注※3

定義されているインデクスを示します。

英字が各インデクスを示し，「-」に続く数字は，インデクスの構成順序を示します。（U）はユニークインデクスを示します。

(3)　案件属性

CIWProcessInstanceインタフェースのAttributeName列挙型で定義されています。

案件属性を次の表に示します。

表B‒3　案件属性一覧

属性名

列挙値

説明

参照※1

条件※2

インデクス※3

ID

ID

案件のID

○

○

A（U），

C-2，

D-2

Name

NAME

案件の名称（案件キー）

○

○

B

ProcessDefinitionName

PROCESS_DEFINITION_NAME

案件が所属するビジネスプロセス定義の名称

○

○

−

ProcessDefinitionID

PROCESS_DEFINITION_ID

案件が所属するビジネスプロセス定義のID

○

○

C-1

StateCode

STATE

案件の状態

○

○

D-1

Creator

CREATOR

案件の投入者

○

○

−

StartDate

START_DATE

案件の開始日時

○

○

−

ClosedDate

CLOSED_DATE

案件の終了日時

○

○

−

Deadline

DEADLINE

案件の処理期限

○

○

−

Priority

PRIORITY

案件の優先度

○

○

−

MovedDate

MOVED_DATE

案件の乗せ替え日時

○

○

−

（凡例）

○：指定できます。

−：定義されているインデクスがありません。

注※1

属性名セットに指定できるかどうかを示します。

注※2

フィルター条件およびソート条件に指定できるかどうかを示します。

注※3

定義されているインデクスを示します。

英字が各インデクスを示し，「-」に続く数字は，インデクスの構成順序を示します。（U）はユニークインデクスを示します。

(4)　業務ステップ属性

CIWActivityInstanceインタフェースのAttributeName列挙型で定義されています。

業務ステップ属性を次の表に示します。

表B‒4　業務ステップ属性一覧

属性名

列挙値

説明

参照※1

条件※2

インデクス※3

ID

ID

業務ステップのID

○

○

A-2（U），

B（U）

Name

NAME

業務ステップの名称（業務ステップキー）

○

○

−

ActivityDefinitionName

ACTIVITY_DEFINITION_NAME

業務ステップ定義の名称

○

○

−

ProcessInstanceID

PROCESS_INSTANCE_ID

業務ステップが所属する案件のID

○

○

A-1（U）

ActivityDefinitionID

ACTIVITY_DEFINITION_ID

業務ステップ定義のID

○

○

−

ProcessDefinitionID

PROCESS_DEFINITION_ID

業務ステップが所属するビジネスプロセス定義のID

○

○

−

ActivityTypeCode

TYPE

業務ステップの種類

○

○

−

StateCode

STATE

業務ステップの状態

○

○

−

StartDate

START_DATE

業務ステップの開始日時

○

○

−

ClosedDate

CLOSED_DATE

業務ステップの終了日時

○

○

−

Deadline

DEADLINE

業務ステップの処理期限

○

○

−

ProcessInstanceName

PROCESS_INSTANCE_NAME

案件名（案件キー）

○

○

−

Priority

PRIORITY

業務ステップの優先度

○

○

−

（凡例）

○：指定できます。

−：定義されているインデクスがありません。

注※1

属性名セットに指定できるかどうかを示します。

注※2

フィルター条件およびソート条件に指定できるかどうかを示します。

注※3

定義されているインデクスを示します。

英字が各インデクスを示し，「-」に続く数字は，インデクスの構成順序を示します。（U）はユニークインデクスを示します。

(5)　作業属性

CIWWorkItemインタフェースのAttributeName列挙型で定義されています。

作業属性を次の表に示します。

表B‒5　作業属性一覧

属性名

列挙値

説明

参照※1

条件※2

インデクス※3

ID

ID

作業のID

○

○

A-2（U），

B-2，

C（U）

Name

NAME

作業の名称（作業キー）

○

○

−

WorkDefinitionName

WORK_DEFINITION_NAME

作業定義の名称

○

○

−

ActivityInstanceID

ACTIVITY_INSTANCE_ID

作業が所属する業務ステップのID

○

○

−

ProcessInstanceID

PROCESS_INSTANCE_ID

作業が所属する案件のID

○

○

A-1（U）

WorkDefinitionID

WORK_DEFINITION_ID

作業定義のID

○

○

−

ProcessDefinitionID

PROCESS_DEFINITION_ID

作業が所属するビジネスプロセス定義のID

○

○

−

WorkTypeCode

TYPE

作業の種類

○

○

−

StateCode

STATE

作業の状態

○

○

−

Priority

PRIORITY

作業の優先度

○

○

−

Participant

PARTICIPANT

作業者のID

○

○

B-1

CreationDate

CREATION_DATE

作業の発生日時

○

○

−

StartDate

START_DATE

作業の開始日時

○

○

−

ClosedDate

CLOSED_DATE

作業の終了日時

○

○

−

Deadline

DEADLINE

作業の処理期限の絶対日時

○

○

−

ProcessInstanceName

PROCESS_INSTANCE_NAME

案件名（案件キー）

○

○

−

（凡例）

○：指定できます。

−：定義されているインデクスがありません。

注※1

属性名セットに指定できるかどうかを示します。

注※2

フィルター条件およびソート条件に指定できるかどうかを示します。

注※3

定義されているインデクスを示します。

英字が各インデクスを示し，「-」に続く数字は，インデクスの構成順序を示します。（U）はユニークインデクスを示します。

付録B.2　指定できる属性値

State属性およびType属性で指定できる値を次に示します。

(1)　State属性で指定できる値

クラスごとのState列挙型で定義されています。

指定できる値は，State列挙型ごとに定義された定数です。

State属性で指定できる値（参照時には属性値として設定される値）を次の表に示します。

表B‒6　State属性で指定できる値

コード値

意味

State列挙型での完全表記形式

PD

PI

AI

WI

CR

a

非活性

inactive

○

−

−

−

○

b

活性

active

○

−

−

−

○

c

未終了

open

−

−

−

−

−

d

実行中

open.running

−

○

○

−

−

e

自動実行

open.running.executing

−

−

−

○

−

f

作業者実行

open.running.performing

−

−

−

○

−

g

停止中

open.notRunning

−

−

−

−

−

h

未実行

open.notRunning.notStarted

−

○

−

−

−

i

初期

open.notRunning.notStarted.initial

−

−

○

○

−

j

実行開始可能

open.notRunning.notStarted.ready

−

−

○

○

−

k

中断

open.notRunning.suspended

−

−

−

−

−

l

実行開始不可

open.notRunning.suspended.disabled

−

−

○

○

−

m

実行停止

open.notRunning.suspended.intermitted

−

○

○

○

−

n

終了

closed

−

−

−

−

−

o

完了

closed.completed

−

○

−

−

−

p

実行省略

closed.completed.notExecuted

−

−

○

○

−

q

実行取消

closed.completed.canceled

−

−

−

○

−

r

実行済

closed.completed.executed

−

−

−

○

−

s

遷移可

closed.completed.executed.readyForTransition

−

−

○

−

−

t

遷移済

closed.completed.executed.transitionCompleted

−

−

○

−

−

u

強制終了

closed.terminated

−

○

○

○

−

v※

異常終了

closed.aborted

−

○

○

○

−

z

未定義

undefined

○

○

○

○

○

（凡例）

PD：ビジネスプロセス定義属性のStateCode属性での指定の可否を示します。

PI：案件属性のStateCode属性での指定の可否を示します。

AI：業務ステップ属性のStateCode属性での指定の可否を示します。

WI：作業属性のStateCode属性での指定の可否を示します。

CR：振り分けルール定義属性のStateCode属性での指定の可否を示します。

○：指定できます。

−：指定できません。

注※

CSCIWではサポートしていません。

(2)　Type属性で指定できる値

クラスごとのType列挙型で定義されています。

指定できる値は，Type列挙型ごとに定義された定数です。

Type列挙型ごとのActivityTypeまたはWorkType値，およびActivityTypeCodeまたはWorkTypeCode値（コード表記形式）を次に示します。

表B‒7　Type属性で指定できる値

コード値

意味

Type列挙型での完全表記形式

AI

WD

WI

0

一般作業

または

業務ステップ

normal

○

○

○

9※

エラー回復作業

または

エラー回復業務ステップ

errorNotice

○

−

○

a※

並列業務ステップ作業

builtin.concurrentActivity

−

○

○

b

並列作業

builtin.concurrentWork

−

○

○

c※

計時作業

builtin.timer

−

○

○

d※

先手通知作業

builtin.followingActivity

−

○

○

z

未定義

undefined

○

○

○

（凡例）

AI：業務ステップ属性のActivityTypeCode属性での指定の可否を示します。

WD：作業定義属性のWorkTypeCode属性での指定の可否を示します。

WI：作業属性のWorkTypeCode属性での指定の可否を示します。

○：指定できます。

−：指定できません。

注※

CSCIWではサポートしていません。

付録C　状態遷移モデル

ワーク管理システムのオブジェクトごとに，状態遷移の動作モデルについて次に示す構成で説明します。

状態遷移図

ワーク管理システムのオブジェクトの状態と遷移の概観を図で示します。

状態

状態ごとの説明とオブジェクト間の状態の制約事項について説明します。

遷移

遷移ごとに，遷移を引き起こす要因と遷移時または遷移後に実行されるワーク管理システムの動作について説明します。

付録C.1　案件の状態遷移

(1)　案件の状態遷移

案件の状態遷移を次の図に示します。

図C‒1　案件の状態遷移

(2)　案件の状態

案件の状態について次の表に示します。

表C‒1　案件の状態一覧

上段：状態

中段：列挙型定数（コード値）

下段：状態の短縮表記形式

状態の完全表記形式

説明

未実行

NOT_STARTED(h)

notStarted

open.notRunning.notStarted

案件が生成されたときの初期の状態を示します。

実行中

RUNNING(d)

running

open.running

案件が実行されている状態を示します。

「実行中」状態の場合だけ，案件に含まれる業務ステップを「実行中」状態にできます。

実行停止

INTERMITTED(m)

intermitted

open.notRunning.suspended.intermitted

案件の実行が中断された一時停止の状態を示します。

「実行停止」状態の案件に含まれる業務ステップは開始できません。

案件が「実行停止」状態になると，業務ステップは「実行開始不可」状態へ遷移します。ただし，すでに実行されている業務ステップはそのまま実行されます。このとき，業務ステップが完了しても，案件は「完了」状態には遷移しないで，「実行停止」状態のままです。

完了

COMPLETED(o)

completed

closed.completed

案件が完了した状態を示します。

「完了」状態の案件に含まれているすべての業務ステップは，「完了」状態または「強制終了」状態です。

強制終了

TERMINATED(u)

terminated

closed.terminated

案件が強制的に終了された状態を示します。

「強制終了」状態の案件に含まれているすべての業務ステップは，「完了」状態または「強制終了」状態です。

(3)　案件の遷移

案件の遷移について次の表に示します。

表C‒2　案件の遷移一覧

遷移種別

要因

および

動作

説明

生成

要因

API呼び出しによる生成要求

動作

案件を生成し，そのあと「未実行」状態へ遷移させます。

開始

（start）

要因

API呼び出しによる遷移要求

動作

「実行中」状態へ遷移し，そのあとフロー定義でソースノードから到達できる業務ステップを活性化します。この場合，対象となる業務ステップのインスタンスが存在しないときは，新規に業務ステップを生成します。

また，事前生成を指定している業務ステップも，このタイミングで生成します。

中断

（suspend）

要因

API呼び出しによる遷移要求

動作

案件を「実行停止」状態へ遷移させます。

再開

（resume）

要因

API呼び出しによる遷移要求

動作

案件を「実行中」状態へ遷移させます。

案件を「実行中」状態へ遷移させると同時に，「実行開始不可」状態のすべての業務ステップも「実行中」状態へ遷移させます。

案件完了

（process completed）

要因

フロー遷移のシンクノードへの到達

（シンクノードへの到達は，ワーク管理システムによるフロー制御で実行）

動作

案件を「完了」状態へ遷移させます。

案件を「完了」状態へ遷移させると同時に次に示す処理を行います。

「初期」状態のすべての業務ステップを「実行省略」状態に遷移。

「初期」状態を除く，すべての「未終了」状態の業務ステップを「強制終了」状態に遷移。

強制終了

（terminate）

要因

API呼び出しによる遷移要求

動作

案件を「強制終了」状態に遷移させます。

案件を「強制終了」状態に遷移させると同時に，「終了」状態以外のすべての業務ステップを「強制終了」状態に遷移させます。

案件の遷移時に設定する属性について次の表に示します。

表C‒3　案件の遷移時に設定する属性一覧

属性名

生成

開始

中断

再開

案件完了

強制終了

ID

○

−

−

−

−

−

Name※1

○

−

−

−

−

−

ProcessDefinitionName

○

−

−

−

−

−

ProcessDefinitionID

○

−

−

−

−

−

StateCode※2

○

○

○

○

○

○

Creator※3

○

−

−

−

−

−

StartDate※4

N

○

−

−

−

−

ClosedDate※4

N

−

−

−

○

○

Deadline※5

○

△

−

−

−

−

Priority※1

○

−

−

−

−

−

MovedDate

N

−

−

−

−

−

（凡例）

○：設定します。

−：設定しません。

△：条件によって設定します。

N：nullを設定します。

注※1

APIで指定された値を設定します。指定されない場合はnullを設定します。

注※2

遷移先の状態を設定します。

注※3

案件の生成または投入を行った場合のユーザ記述子を設定します。

注※4

遷移が行われた時刻を設定します。

注※5

案件の生成時はAPIで指定された値を設定します。指定されない場合はnullを設定します。

また，案件の開始（start）時は次に示す条件で設定します。

生成時に設定した値がnull以外の場合

開始（start）時は値を設定しません。生成時の値のままです。

生成時に設定した値がnullの場合

処理期限ルールが定義されていない場合

開始（start）時は値を設定しません。生成時の値のままです。

処理期限ルールが定義されている場合

処理期限ルールの評価結果を設定します。

付録C.2　業務ステップの状態遷移

(1)　業務ステップの状態遷移

業務ステップの状態遷移を次の図に示します。

図C‒2　業務ステップの状態遷移

(2)　業務ステップの状態

業務ステップの状態について次の表に示します。

表C‒4　業務ステップの状態一覧

上段：状態

中段：列挙型定数（コード値）

下段：状態の短縮表記形式

状態の完全表記形式

説明

初期

INITIAL(i)

initial

open.notRunning.notStarted.initial

業務ステップが生成されたときの初期の状態を示します。

実行開始可能

READY(j)

ready

open.notRunning.notStarted.ready

業務ステップとして実行できる状態ですが，まだ実行開始されていない一時的な状態を示します。

実行中

RUNNING(d)

running

open.running

業務ステップが実行されている状態を示します。

「実行中」状態の場合だけ，業務ステップに含まれる作業を「実行中」状態にできます。

また，「実行中」状態の場合だけ，業務ステップの評価が行われます。

実行開始不可

DISABLED(l)

disabled

open.notRunning.suspended.disabled

案件が「実行停止」状態のため，業務ステップを実行できない状態を示します。

案件が「実行停止」状態から再開されたときに，業務ステップも「実行開始可能」状態になります。

実行停止

INTERMITTED(m)

intermitted

open.notRunning.suspended.intermitted

業務ステップの実行が中断された一時停止の状態を示します。

「実行停止」状態の場合，業務ステップは完了できません。

また，「実行停止」状態の業務ステップに含まれる作業は開始できません。ただし，すでに実行されている作業はそのまま実行されます。

なお，「実行停止」状態の場合，業務ステップの評価は行われません。

遷移可

READY_FOR_TRANSITION(s)

readyForTransition

closed.completed.executed.readyForTransition

業務ステップが完了し，次の業務ステップへ遷移できる状態を示します。

業務ステップが「遷移可」状態へ遷移した場合は，対象となる業務ステップに含まれているすべての作業は「終了」状態です。

遷移済

TRANSITION_COMPLETED(t)

transitionCompleted

closed.completed.executed.transitionCompleted

業務ステップが次の業務ステップへフロー遷移した状態を示します。

実行省略

NOT_EXECUTED(p)

notExecuted

closed.completed.notExecuted

業務ステップが何も実行されないで完了した状態を示します。

案件が遷移していく過程で，業務ステップを通らないで案件が完了した場合に，この業務ステップは「実行省略」状態になります。

強制終了

TERMINATED(u)

terminated

closed.terminated

業務ステップが強制的に終了された状態を示します。

業務ステップが「強制終了」状態へ遷移した場合は，対象となる業務ステップに含まれているすべての作業は「完了」状態または「強制終了」状態です。

なお，強制終了された業務ステップは，次の業務ステップへ遷移されません。

このとき，ほかに「実行中」状態の業務ステップが存在しない場合は，案件を強制終了する以外の操作ができなくなるため，注意してください。

また，実行中の業務ステップが存在している場合でも，待合ノードに続く業務ステップを強制終了すると，案件は待合ノードから遷移されなくなるため，注意してください。

(3)　業務ステップの遷移

業務ステップの遷移について次の表に示します。

表C‒5　業務ステップの遷移一覧

遷移種別

要因

および

動作

説明

生成

要因

フロー制御（未生成業務ステップへのフロー遷移）

事前生成が設定された業務ステップの場合，案件の「実行中」状態への遷移時

API呼び出しによる生成要求

動作

業務ステップを「初期」状態で生成します。

活性化

（activate）

要因

API呼び出しによる活性化要求

フロー制御（業務ステップへのフロー遷移）

動作

業務ステップを「実行開始可能」状態へ遷移させます。そのあと，続けて次に示す状態遷移を行います。

案件が「実行中」状態の場合は，「実行中」状態へ遷移。

案件が「実行中」状態以外の場合は，「実行開始不可」状態へ遷移。

開始

（start）

要因

業務ステップが「実行開始可能」状態へ遷移したときに，案件が「実行中」状態の場合

動作

業務ステップを「実行中」状態へ遷移させ，そのあと業務ステップの評価処理を行います。

中断

（suspend）

要因

API呼び出しによる遷移要求

動作

業務ステップを「実行停止」状態へ遷移させます。

業務ステップを「実行停止」状態へ遷移させると同時に，対象となる業務ステップに含まれるすべての「未実行」状態の作業を「実行開始不可」状態へ遷移させます。

再開

（resume）

要因

API呼び出しによる遷移要求

動作

業務ステップを「実行中」状態へ遷移させ，そのあと業務ステップの評価処理を行います。

業務ステップを「実行中」状態へ遷移させると同時に，対象となる業務ステップに含まれるすべての「実行開始不可」状態の作業を「未実行」状態へ遷移させます。

業務ステップ完了

（activity completed）

要因

API呼び出しによる「実行済」状態への遷移要求

業務ステップの評価処理で，完了要件が満たされた場合

例えば，業務ステップに含まれるすべての作業が「完了」状態へ遷移した場合や業務ステップの完了条件が存在する場合に条件が満たされたときなどです。

動作

業務ステップを「遷移可」状態へ遷移させます。

業務ステップを「遷移可」状態へ遷移させると同時に，対象となる業務ステップに含まれる作業に対して次に示す処理を行います。

すべての「未実行」状態の作業を「実行省略」状態へ遷移。

すべての「実行中」状態の作業を「実行取消」状態へ遷移。

すべての「実行停止」状態の作業を「強制終了」状態へ遷移。

実行開始可

（enable）

要因

案件の「再開」状態への遷移

動作

業務ステップを「実行開始可能」状態へ遷移させ，そのあと続けて「実行中」状態へ遷移させます。

実行開始不可

（disable）

要因

業務ステップが「実行開始可能」状態へ遷移したときに，案件が「実行停止」状態の場合

動作

業務ステップを「実行開始不可」状態へ遷移させます。

フロー遷移

（transit）

要因

次の業務ステップへのフロー遷移処理時。

ただし，次のどちらかの場合はフロー遷移しません。

遷移先がない

遷移先に「未終了」状態，かつ「初期」状態でない業務ステップが存在する（遷移先の業務ステップ間に制御ノードがある場合を除く）

動作

業務ステップを「遷移済」状態へ遷移させます。

実行省略

（skip）

要因

案件の「完了」状態への遷移時（「案件完了」），および案件の完了時（シンクノードへの到達など）に，業務ステップが「初期」状態の場合

動作

業務ステップを「実行省略」状態へ遷移させます。

強制終了

（terminate）

要因

API呼び出しによる遷移要求

案件の状態遷移に伴う制約

案件の状態遷移に伴う制約については，「表C-2　案件の遷移一覧」の「案件完了」状態遷移および「強制終了」状態遷移を参照してください。

動作

業務ステップを「強制終了」状態に遷移させます。

業務ステップを「強制終了」状態に遷移させると同時に，対象となる業務ステップに含まれる「終了」状態以外のすべての作業を強制終了させます。

業務ステップの遷移時に設定する属性について次の表に示します。

表C‒6　業務ステップの遷移時に設定する属性一覧

属性名

生成

活性化

開始

中断

再開

業務ステップ完了

実行開始可

実行開始不可

フロー遷移

実行省略

強制終了

ID

○

−

−

−

−

−

−

−

−

−

−

Name※1

○

−

−

−

−

−

−

−

−

−

−

ActivityDefinitionName

○

−

−

−

−

−

−

−

−

−

−

ProcessInstanceID

○

−

−

−

−

−

−

−

−

−

−

ActivityDefinitionID

○

−

−

−

−

−

−

−

−

−

−

ProcessDefinitionID

○

−

−

−

−

−

−

−

−

−

−

ActivityTypeCode

○

−

−

−

−

−

−

−

−

−

−

StateCode※2

○

○

○

○

○

○

○

○

○

○

○

StartDate※3

N

−

○

−

−

−

−

−

−

−

−

ClosedDate※3

N

−

−

−

−

○

−

−

−

○

○

Deadline※4

N

−

○

−

−

−

−

−

−

−

−

ProcessInstanceName

○

−

−

−

−

−

−

−

−

−

−

Priority※5

○

−

−

−

−

−

−

−

−

−

−

（凡例）

○：設定します。

−：設定しません。

N：nullを設定します。

注※1

子業務ステップの場合は，生成ルールが返した値を設定します。

子業務ステップ以外の場合は，nullを設定します。

注※2

遷移先の状態を設定します。

注※3

遷移が行われた時刻を設定します。

注※4

開始（start）時は次の条件で設定します。

処理期限ルールが定義されていない場合

値を設定しません。生成時の値のままです。

処理期限ルールが定義されている場合

処理期限ルールの評価結果を設定します。

注※5

Priorityには案件のPriorityの値を設定します。

付録C.3　作業の状態遷移

(1)　作業の状態遷移

作業の状態遷移を次の図に示します。

図C‒3　作業の状態遷移

(2)　作業の状態

作業の状態について次の表に示します。

表C‒7　作業の状態一覧

上段：状態

中段：列挙型定数（コード値）

下段：状態の短縮表記形式

状態の完全表記形式

説明

初期

INITIAL(i)

initial

open.notRunning.notStarted.initial

作業が生成されたときの初期の状態を示します。

実行開始可能

READY(j)

ready

open.notRunning.notStarted.ready

作業が実行できる状態を示します。

作業が「実行開始可能」状態へ遷移した時点で，作業者への割り当て（リソースセレクション）は実行済みです。このため，作業者からは実行開始可能な作業として見えます。

なお，「実行開始可能」状態の場合，作業の評価および作業者振り分けルールの再評価ができます。

作業が「作業者実行」状態となるタイミングは次のとおりです。

作業が生成されたあとに，引き続いて遷移されたとき（ワーク管理システムによって作業が生成されたとき）

作業者（外部リソース）によって，「作業の返却と振り分けルールの再評価」の処理が実行されたとき

自動実行

EXECUTING(e)

executing

open.running.executing

作業が自動的に実行されている状態を示します。

組み込み作業など，ワーク管理システムが制御する作業が実行されていることを示します。

なお，「自動実行」状態の場合，作業の評価ができます。

作業者実行

PERFORMING(f)

performing

open.running.performing

作業者が作業を実行している状態を示します。

人的リソースによる作業の実行など，ワーク管理システムの外部リソースによって作業が実行されていることを示します。

なお，「作業者実行」状態の場合，作業の評価および作業者振り分けルールの再評価ができます。

作業が「作業者実行」状態となるタイミングは次のとおりです。

作業者（外部リソース）によって作業が実行されたとき

作業アプリケーション（同期）によって作業が実行されたとき

作業者（外部リソース）によって，「条件に一致する作業の作業者割り当てと着手」の処理が実行されたとき

実行省略

NOT_EXECUTED(p)

notExecuted

closed.completed.notExecuted

作業が何も実行されないで完了した状態を示します。

「未実行」状態の作業を含む業務ステップが「完了」状態になった場合，この作業は「実行省略」状態になります。

また，発生と同時に作業の完了条件が満たされた場合，作業は「実行省略」状態になります。

実行取消

CANCELED(q)

canceled

closed.completed.canceled

作業の実行が取り消された状態を示します。

「実行中」状態の作業を含む業務ステップが「完了」状態になった場合に，この作業は「実行取消」状態になります。

実行済

EXECUTED(r)

executed

closed.completed.executed

ワーク管理システムまたは作業者によって，作業が実行され，完了した状態を示します。

「自動実行」状態の作業の場合，作業の完了条件が満たされると「実行済」状態になります。

また，「作業者実行」状態の作業の場合，「実行済」状態となるタイミングは次のとおりです。

作業者（外部リソース）によって作業が完了されたときに

作業アプリケーション（同期）によって作業が完了されたとき

実行開始不可

DISABLED(l)

disabled

open.notRunning.suspended.disabled

業務ステップが「実行停止」状態のため，作業を開始または着手できない状態を示します。

業務ステップが「実行停止」状態へ遷移した場合に，業務ステップに含まれるすべての「未実行」状態の作業は「実行開始不可」状態へ遷移します。

なお，作業が「実行開始不可」状態の場合は，作業者振り分けルールの再評価ができます。

実行停止

INTERMITTED(m)

intermitted

open.notRunning.suspended.intermitted

作業の実行が中断された一時停止の状態を示します。

作業実行の一時停止を，その作業の作業者へ要求する場合に，APIによって，「実行停止」状態への遷移要求を出します。

なお，作業が「実行停止」状態の場合は，作業者振り分けルールの再評価ができます。

強制終了

TERMINATED(u)

terminated

closed.terminated

作業が強制的に終了された状態を示します。

APIによって強制終了が要求された場合 ，作業は「強制終了」状態になります。

また，作業を含む業務ステップが「強制終了」状態になった場合，この作業は「強制終了」状態になります。

なお，強制終了された作業が含まれる業務ステップは，完了条件が評価されません。この場合は，業務ステップを直接完了させるか，またはCIWActivityInstance#evaluate()を使用して業務ステップの完了条件を評価し，業務ステップの完了または作業の再作成をしてください。作業を再作成する場合は，作業の発生条件および完了条件を適切に定義してください。

(3)　作業の遷移

作業の遷移について次の表に示します。

表C‒8　作業の遷移一覧

遷移種別

要因

および

動作

説明

生成

要因

作業の発生条件が満たされた場合（業務ステップの評価処理時）

動作

作業を「初期」状態で生成します。

準備済

（ready）

要因

作業の生成時に引続いて遷移する場合（ワーク管理システムによって生成された場合）

動作

作業の完了条件を評価し，条件が満たされた場合は，続けて「実行省略」状態へ遷移させます。

条件が満たされなかった場合は，振分ルール評価（リソースセレクション）を実行し，作業者を割り当てたあとで「実行開始可能」状態へ遷移します。

開始

（start）

要因

組み込み作業の「実行開始可能」状態への遷移

動作

作業を「自動実行」状態へ遷移させます。

着手

（get）

要因

API呼び出しによる遷移要求

動作

作業を「作業者実行」状態へ遷移させます。

返却

（back）

要因

API呼び出しによる遷移要求

動作

作業を「実行開始可能」状態へ遷移させます。

作業完了

（workitem completed）

要因

API呼び出しによる遷移要求

作業の評価処理で完了条件が満たされた場合（作業の完了条件あり）

組み込み作業の完了時

動作

作業を「実行済」状態へ遷移させます。

完了通知

（complete）

要因

API呼び出しによる遷移要求

作業の評価処理で完了条件が満たされた場合。（作業の完了条件あり）

動作

作業を「実行済」状態へ遷移させます。

実行省略

（skip）

要因

業務ステップの「遷移可」状態への遷移時

作業評価時に完了条件が満たされた場合

動作

作業を「実行省略」状態へ遷移させます。

実行取消

（cancel）

要因

業務ステップの「遷移可」状態への遷移時

動作

作業を「実行取消」状態へ遷移させます。

ワーク管理システムによって実行制御が行われている作業の場合は，「実行取消」状態へ遷移することで，実際の作業実行の強制終了制御を行います。

中断

（suspend）

要因

API呼び出しによる遷移要求

動作

作業を「実行停止」状態へ遷移させます。

ワーク管理システムによって実行制御が行われている作業の場合は，「中断」状態へ遷移することで，実際の作業実行の停止制御を行います。

再開

（resume）

要因

API呼び出しによる遷移要求

動作

作業を「自動実行」状態，または「作業者実行」状態へ遷移させます。

ワーク管理システムによって実行制御が行われている作業の場合は，「再開」状態へ遷移することで，実際の作業実行の再開制御を行います。

実行開始不可

（disable）

要因

業務ステップの「実行停止」状態への遷移時

作業の「実行開始可能」状態への遷移時に，作業を含む業務ステップが「実行停止」状態の場合

動作

作業を「実行開始不可」状態へ遷移させます。

実行開始可

（enable）

要因

業務ステップの「実行中」状態への遷移時

動作

作業を「実行開始可能」状態へ遷移させます。

強制終了

（terminate）

要因

API呼び出しによる遷移要求

業務ステップの状態遷移に伴う制約

業務ステップの状態遷移に伴う制約については，「表C-5　業務ステップの遷移一覧」の「業務ステップ完了」状態遷移および「強制終了」状態遷移を参照してください。

動作

作業の状態を「強制終了」状態へ遷移させます。

ワーク管理システムによって実行制御が行われている作業の場合は，「強制終了」状態へ遷移することで，実際の作業実行の中断制御を行います。

作業の遷移時に設定する属性について次の表に示します。

表C‒9　作業の遷移時に設定する属性一覧

属性名

生成

準備済

開始

着手

返却

作業完了

完了通知

実行省略

実行取消

中断

再開

実行開始不可

実行開始可

強制終了

ID

○

−

−

−

−

−

−

−

−

−

−

−

−

−

Name※1

○

−

−

−

−

−

−

−

−

−

−

−

−

−

WorkDefinitionName

○

−

−

−

−

−

−

−

−

−

−

−

−

−

ActivityInstanceID

○

−

−

−

−

−

−

−

−

−

−

−

−

−

ProcessInstanceID

○

−

−

−

−

−

−

−

−

−

−

−

−

−

WorkDefinitionID

○

−

−

−

−

−

−

−

−

−

−

−

−

−

ProcessDefinitionID

○

−

−

−

−

−

−

−

−

−

−

−

−

−

WorkTypeCode

○

−

−

−

−

−

−

−

−

−

−

−

−

−

StateCode※2

○

○

○

○

○

○

○

○

○

○

○

○

○

○

Participant

N

○

−

−

−

−

−

−

−

−

−

−

−

−

CreationDate※3

N

○

−

−

−

−

−

−

−

−

−

−

−

−

StartDate※4

N

−

○

○

−

−

−

−

−

−

−

−

−

−

ClosedDate※3

N

−

−

−

−

○

○

○

○

−

−

−

−

○

Deadline※5

○

△

−

−

−

−

−

−

−

−

−

−

−

−

ProcessInstanceName

○

−

−

−

−

−

−

−

−

−

−

−

−

−

Priority※6

○

−

−

−

−

−

−

−

−

−

−

−

−

−

（凡例）

○：設定します。

−：設定しません。

△：条件によって設定します。

N：nullを設定します。

注※1

子作業の場合は，生成ルールが返した値を設定します。

子作業以外の場合は，nullを設定します。

注※2

遷移先の状態を設定します。

注※3

遷移が行われた時刻を設定します。

注※4

遷移が行われた時刻を設定します。返却（back）への遷移時は未設定に戻しません。2回目の開始（start）の遷移が行われた場合は，遷移が行われた時刻を設定します。

注※5

生成時は業務ステップのDeadlineの値を設定します。開始（start）時にnullが設定されている場合は，業務ステップのDeadlineの値を設定します。

注※6

業務ステップのPriorityの値を設定します。

付録D　WorkCoordinator Definerで作成された定義ファイルの利用

CSCIWでは，WorkCoordinator Definerで作成したビジネスプロセス定義ファイルおよび振り分けルール定義ファイルを利用できます。WorkCoordinator Definerで作成した定義ファイルは，CSCIW-Definerを使用して読み込みます。なお，CSCIWでサポートしていない項目が定義されている場合は，読み込み時にCSCIW-Definerが対象の項目を削除します。削除された項目については，メッセージに出力されます。

WorkCoordinator Definerでサポートしているビジネスプロセス定義および振り分けルール定義の機能のうち，CSCIWで利用できる機能を次の表に示します。

表D‒1　CSCIWで利用できるWorkCoordinator Definerの機能（ビジネスプロセス定義の場合）

機能

利用可否

ソースノード

○

シンクノード

○

業務ステップ

事前生成

○

完了条件

○

処理期限

○

説明

○

作業

作業アプリケーション

×

振り分けルール

○

発生条件※

○

完了条件

○

条件再評価

○

説明

○

組み込み作業

並列業務ステップ

×

並列作業

○

計時作業

×

先手通知作業

×

制御ノード

分岐

○

分業

○

先着（後続停止あり）

○

先着（後続停止なし）

○

待合

○

アロー

○

条件

論理データモデル

論理データ項目

×

物理データモデル

RDB検索

○

分散オブジェクト

×

プロセスデータ

×

ルール

生成ルール

論理データモデル

論理データ項目

×

物理データモデル

RDB検索

○

分散オブジェクト

×

プロセスデータ

×

時間取得ルール

論理データモデル

論理データ項目

×

物理データモデル

RDB検索

×

分散オブジェクト

×

プロセスデータ

×

相対時刻

○

作業アプリケーション情報

×

論理データ項目

×

プロセスデータ

×

階層

○

ビジネスプロセスのプロパティ

バージョン

○

処理期限ルール

○

アドホック要求を使用する

○

状態

○

管理者

○

案件投入可能期間

○

説明

○

（凡例）

○：利用できます。

×：利用できません。

注※　並列作業の子作業以外は，条件に「@False」を設定できません。

表D‒2　CSCIWで利用できるWorkCoordinator Definerの機能（振り分けルール定義の場合）

機能

利用可否

振り分けルール

RDB検索

○

分散オブジェクト

×

振り分けルールのプロパティ

バージョン

○

管理者

○

有効期間

○

説明

○

（凡例）

○：利用できます。

×：利用できません。

付録E　各バージョンの変更内容

付録E.1　03-00の変更内容

Cosminexus V11に対応しました。

業務アプリケーションをコンパイルする場合のクラスパスの設定方法を変更しました。

また，Java API 利用時に，uCosminexus Business Process Developerをインストールした環境で業務アプリケーションをコンパイルするときにクラスパスに指定するJAR ファイルの説明を追加しました。

条件に一致する作業の作業者割り当てと着手をする場合の実装例を2.6から2.3.5に移動しました。

付録E.2　02-30の変更内容

FirefoxおよびChromeに対応しました。

付録E.3　02-20の変更内容

業務プログラムのコンパイルで使用するJDKのバージョンをJDK8.0に変更しました。

条件に一致する作業の作業者割り当てと着手をする場合の実装例を追加しました。

CIWServerインタフェースにallocateWorkItemExメソッドを追加しました。

CIWWorkItemインタフェースにfreeメソッドを追加しました。

業務ステップ遷移一覧の遷移種別「フロー遷移」の要因の説明に，フロー遷移しない場合の説明を追加しました。

作業の状態一覧の状態「実行開始可能」および「作業者実行」の「説明」に，「作業者実行」状態に遷移するタイミングについての説明を追加しました。

付録E.4　02-10の変更内容

Javaオブジェクト作成時の注意事項を追加しました。

付録E.5　02-00の変更内容

BPMN連携機能を追加しました。

CIWActivityInstanceインタフェースにadhocMakeTransitionメソッドを追加しました。

CIWProcessInstanceインタフェースにadhocInstantiateActivityInstanceメソッドを追加しました。

業務ステップ遷移一覧に，遷移種別「生成」の要因の説明として，API呼び出しによる生成要求を追加しました。

付録E.6　01-95の変更内容

なし。

付録E.7　01-90の変更内容

例外がスローされる設定項目に次のSQLSTATEを追加しました。

HiRDBTransientSQLState

OracleTransientSQLState

SQLServerTransientSQLState

付録E.8　01-70の変更内容

Cosminexus V8に対応しました。

次の組み込み変数を追加しました。

@PICreator，@PIStartDate，@PIDeadline，@PIPriority，@AIStartDate，@AIDeadline，@AIPriority，@WICreationDate，@WIStartDate，@WIDeadline，@WIPriority，@WIParticipant，@UserID

組み込み変数に関する注意事項を追加しました。

クラスパスに設定するJARファイルに「csciwcmn.jar」を追加しました。

Javaオブジェクト呼び出しへの対応に伴い，説明を追加しました。

作業アプリケーション呼び出しへの対応に伴い，説明を追加しました。

CSCIWで管理するトランザクションに関する説明を追加しました。

パッケージ「jp.co.Hitachi.soft.csciw.callback」の追加に伴い，APIの一覧をパッケージごとに分けました。

パッケージ「jp.co.Hitachi.soft.csciw.callback」の追加に伴い，CSCIWのクラスの構成をパッケージごとに分けました。

パッケージ「jp.co.Hitachi.soft.csciw.callback」の階層を追加しました。

initializeCIWFactory（CIWAdminクラスのメソッド）にSQL Serverの場合を追加しました。

次のインタフェースを追加しました。

CIWConditionEvaluator（条件Javaオブジェクトのインタフェース），CIWCreationRuleEvaluator（生成ルールJavaオブジェクトのインタフェース），CIWResourceSelector（振り分けルールJavaオブジェクトのインタフェース），CIWWorkApplication（作業アプリケーションJavaオブジェクトのインタフェース）

パッケージ「jp.co.Hitachi.soft.csciw.callback」が提供する列挙型を追加しました。

パッケージ「jp.co.Hitachi.soft.csciw.callback」の例外クラスを追加しました。

CSCIWで使用するAPIに更新系APIおよび参照系APIを追加しました。

次の作業の状態の説明を変更しました。

作業者実行，実行済

付録E.9　01-60の変更内容

ビジネスプロセスを管理するツールを，WorkCoordinator DefinerからCSCIW-Definerへ変更しました。

ビジネスプロセスの変更に，定義のバージョンを更新する場合の手順を追加しました。

CSCIWがワーク管理データベースを検索するときのSQL文の評価規則，および注意事項を追加しました。

CIWActivityInstance（業務ステップのインタフェース）に，引き戻しまたは差し戻しができるmakeBackwardTransitionメソッドを追加しました。

例外クラスCIWTransientExceptionが発生する要因の説明に，SQL Server使用時にSQL例外となるSQLCODEの値を設定する，セットアッププロパティファイルの設定項目「SQLServerTransientSQLCode」を追加しました。

付録F　このマニュアルの参考情報

このマニュアルを読むに当たっての参考情報を示します。

付録F.1　関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

(1)　CSCIW関連

uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド（3020-3-M80）

uCosminexus Service Coordinator Interactive Workflow 案件運用操作ガイド（3020-3-M82）

uCosminexus Service Coordinator Interactive Workflow メッセージ（3020-3-M83）

uCosminexus Service Coordinator Interactive Workflow コマンド（3020-3-M84）

uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド（3020-3-M85）

uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引（3020-3-M86）

(2)　Cosminexus関連

Cosminexus V11 アプリケーションサーバ システム構築・運用ガイド（3021-3-J02）

Cosminexus V11 アプリケーションサーバ 機能解説 基本・開発編（Webコンテナ）（3021-3-J05）

Cosminexus V11 アプリケーションサーバ 機能解説 基本・開発編（EJBコンテナ）（3021-3-J06）

Cosminexus V11 アプリケーションサーバ 機能解説 基本・開発編（コンテナ共通機能）（3021-3-J07）

Cosminexus V11 アプリケーションサーバ 機能解説 拡張編（3021-3-J08）

Cosminexus V11 アプリケーションサーバ 機能解説 運用／監視／連携編（3021-3-J10）

Cosminexus V11 アプリケーションサーバ 機能解説 保守／移行編（3021-3-J11）

Cosminexus V11 アプリケーションサーバ 機能解説 互換編（3021-3-J12）

Cosminexus V11 アプリケーションサーバ アプリケーション設定操作ガイド（3021-3-J13）

Cosminexus V11 アプリケーションサーバ リファレンス コマンド編（3021-3-J15）

Cosminexus V11 アプリケーションサーバ リファレンス 定義編（サーバ定義）（3021-3-J16）

Cosminexus V11 アプリケーションサーバ リファレンス 定義編（アプリケーション／リソース定義）（3021-3-J17）

Cosminexus V11 アプリケーションサーバ アプリケーション開発ガイド（3021-3-J20）

Cosminexus V11 BPM/ESB基盤 サービスプラットフォーム システム構築・運用ガイド（3021-3-J45）

なお，このマニュアルでは，Cosminexus関連のマニュアルについて，バージョン番号を省略して表記しています。

(3)　HiRDB関連

HiRDB Version 10 解説（3020-6-551）

HiRDB Version 10 システム導入・設計ガイド（UNIX(R)用）（3020-6-552）

HiRDB Version 10 システム定義（UNIX(R)用）（3020-6-554）

HiRDB Version 10 システム運用ガイド（UNIX(R)用）（3020-6-556）

HiRDB Version 10 コマンドリファレンス（UNIX(R)用）（3020-6-558）

HiRDB Version 10 システム導入・設計ガイド（Windows(R)用）（3020-6-553）

HiRDB Version 10 システム定義（Windows(R)用）（3020-6-555）

HiRDB Version 10 システム運用ガイド（Windows(R)用）（3020-6-557）

HiRDB Version 10 コマンドリファレンス（Windows(R)用）（3020-6-559）

HiRDB Version 10 UAP開発ガイド（3020-6-560）

HiRDB Version 10 SQLリファレンス（3020-6-561）

HiRDB Version 10 メッセージ（3020-6-562）

なお，このマニュアルでは，HiRDB関連のマニュアルについて，バージョン番号を省略して表記しています。

付録F.2　このマニュアルでの表記

このマニュアルで使用している表記と，対応する製品名を次に示します。

表記

製品名

AIX※

IBM AIX V7.1

Chrome

Google Chrome

Cosminexus

uCosminexus Application Server

CSCIW

uCosminexus Service Coordinator Interactive Workflow

Firefox

Mozilla Firefox

HiRDB

HiRDB Server Version 10

Linux※

Red Hat(R) Enterprise Linux(R) Server 7.1（64-bit x86_64）以降

Red Hat(R) Enterprise Linux(R) Server 8.1（64-bit x86_64）以降

ORACLE

Oracle 18c

Oracle(R) Database 18c

Oracle 19c

Oracle(R) Database 19c

WorkCoordinator Definer

WorkCoordinator Definer Version 6

注※

AIXおよびLinuxの製品名称を特に区別する必要がない場合，UNIXと表記しています。

付録F.3　マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記

製品名

Internet Explorer，またはIE

Internet Explorer 11

SQL Server

SQL Server 2005

Microsoft SQL Server 2005

SQL Server 2008

Microsoft SQL Server 2008

SQL ServerのJDBCドライバ

Microsoft SQL Server 2005 JDBC Driver 1.1

Microsoft SQL Server 2005 JDBC Driver 1.2

Microsoft SQL Server JDBC Driver 2.0

Microsoft SQL Server JDBC Driver 3.0

Windows Server

Windows Server 2016

Microsoft Windows Server 2016 Standard 日本語版

Microsoft Windows Server 2016 Datacenter 日本語版

Windows Server 2019

Microsoft Windows Server 2019 Standard 日本語版

Microsoft Windows Server 2019 Datacenter 日本語版

Windows

Windows 10

Windows 10 Pro 日本語版(64ビット版)

Windows 10 Enterprise 日本語版(64ビット版)

Windows Server 2016，Windows Server 2019，およびWindows 10を特に区別する必要がない場合，Windowsと表記しています。

付録F.4　このマニュアルで使用している略語

このマニュアルで使用している英略語を次に示します。

英略語

英字での表記

EJB

Enterprise JavaBeans

GMT

Greenwich Mean Time

J2EE

Java 2 Platform, Enterprise Edition，およびJ2EE

JAR

Java ARchive

JDBC

Java Database Connectivity，およびJDBC

JDK

Java Development Kit，およびJDK

付録F.5　KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

索引

A

adhocInstantiateActivityInstance〔CIWProcessInstance〕[1]

adhocInstantiateActivityInstanceで発生する例外〔CIWProcessInstance〕[1]

adhocInstantiateActivityInstanceの引数〔CIWProcessInstance〕[1]

adhocMakeTransition〔CIWActivityInstance〕[1]

adhocMakeTransitionで発生する例外〔CIWActivityInstance〕[1]

adhocMakeTransitionの引数〔CIWActivityInstance〕[1]

allocateWorkItemEx〔CIWServer〕[1]

allocateWorkItemExで発生する例外〔CIWServer〕[1]

allocateWorkItemExの引数〔CIWServer〕[1]

aNewStateで指定できる案件の状態〔CIWProcessInstance〕[1]

aNewStateで指定できる業務ステップの状態〔CIWActivityInstance〕[1]

aNewStateで指定できる作業の状態〔CIWWorkItem〕[1]

APIの特長[1]

API利用時の注意事項[1]

attachDatabaseConnection〔CIWConnectionCoordinator〕[1]

attachDatabaseConnectionで発生する例外〔CIWConnectionCoordinator〕[1]

attachDatabaseConnectionの引数〔CIWConnectionCoordinator〕[1]

C

changeState〔CIWActivityInstance〕[1]

changeState〔CIWProcessInstance〕[1]

changeState〔CIWWorkItem〕[1]

changeStateで発生する例外〔CIWActivityInstance〕[1]

changeStateで発生する例外〔CIWProcessInstance〕[1]

changeStateで発生する例外〔CIWWorkItem〕[1]

changeStateの引数〔CIWActivityInstance〕[1]

changeStateの引数〔CIWProcessInstance〕[1]

changeStateの引数〔CIWWorkItem〕[1]

CIWActivityInstance[1]

CIWActivityInstance.AttributeName[1]

CIWActivityInstance.AttributeNameのメソッド[1]

CIWActivityInstance.AttributeNameの列挙型定数[1]

CIWActivityInstance.State[1]

CIWActivityInstance.Stateのメソッド[1]

CIWActivityInstance.Stateの列挙型定数[1]

CIWActivityInstance.Type[1]

CIWActivityInstance.Typeのメソッド[1]

CIWActivityInstance.Typeの列挙型定数[1]

CIWActivityInstanceインタフェースのメソッド[1]

CIWActivityInstanceの入れ子のクラス[1]

CIWAdmin[1]

CIWAdminクラスのメソッド[1]

CIWConditionEvaluator[1]

CIWConditionEvaluator.Parameter[1]

CIWConditionEvaluator.Parameterのメソッド[1]

CIWConditionEvaluator.Parameterの列挙型定数[1]

CIWConditionEvaluatorインタフェースのメソッド[1]

CIWConditionEvaluatorの入れ子のクラス[1]

CIWConnectionCoordinator[1]

CIWConnectionCoordinatorクラスのメソッド[1]

CIWConnectionCoordinatorを使用したConnectionオブジェクトの関連づけ〔業務プログラムで管理するトランザクション（CIWServerとコネクションの関連づけ）〕[1]

CIWConnectionCoordinatorを使用してコネクションと関連づける場合〔CIWServerオブジェクトの生成〕[1]

CIWCreationRuleEvaluator[1]

CIWCreationRuleEvaluator.Parameter[1]

CIWCreationRuleEvaluator.Parameterのメソッド[1]

CIWCreationRuleEvaluator.Parameterの列挙型定数[1]

CIWEntityNotExistException[1]

CIWException[1]

CIWException直系の既知のサブクラス[1]

CIWFactory[1]

CIWFactoryオブジェクトの取得[1]

CIWFactoryクラスのメソッド[1]

CIWFactoryとCIWServerオブジェクトの生成クラス[1]

CIWFatalException[1]

CIWFatalException直系の既知のサブクラス[1]

CIWProcessDefinition[1]

CIWProcessDefinition.AttributeName[1]

CIWProcessDefinition.AttributeNameのメソッド[1]

CIWProcessDefinition.AttributeNameの列挙型定数[1]

CIWProcessDefinition.State[1]

CIWProcessDefinition.Stateのメソッド[1]

CIWProcessDefinition.Stateの列挙型定数[1]

CIWProcessDefinitionインタフェースの入れ子のクラス[1]

CIWProcessDefinitionインタフェースのメソッド[1]

CIWProcessInstance[1]

CIWProcessInstance.AttributeName[1]

CIWProcessInstance.AttributeNameのメソッド[1]

CIWProcessInstance.AttributeNameの列挙型定数[1]

CIWProcessInstance.State[1]

CIWProcessInstance.Stateのメソッド[1]

CIWProcessInstance.Stateの列挙型定数[1]

CIWProcessInstanceインタフェースの入れ子のクラス[1]

CIWProcessInstanceインタフェースのメソッド[1]

CIWResourceSelector[1]

CIWResourceSelector.Parameter[1]

CIWResourceSelector.Parameterのメソッド[1]

CIWResourceSelector.Parameterの列挙型定数[1]

CIWResourceSelectorインタフェースのメソッド[1]

CIWResourceSelectorの入れ子のクラス[1]

CIWServer[1]

CIWServer.Targetkind[1]

CIWServer.Targetkindのメソッド[1]

CIWServer.Targetkindの列挙型定数[1]

CIWServerインタフェースの入れ子のクラス[1]

CIWServerインタフェースのメソッド[1]

CIWServerオブジェクトに対するConnectionオブジェクトの関連づけ[1]

CIWServerオブジェクトに対するConnectionオブジェクトの関連づけの解除[1]

CIWServerオブジェクトの生成[1]

CIWServerとJDBCコネクションの関連づけを管理するクラス[1]

CIWServerとコネクションの関連づけ〔業務プログラムで管理するトランザクション〕[1]

CIWSQLException[1]

CIWSQLExceptionのメソッド[1]

CIWSQLTransientException[1]

CIWSQLTransientExceptionのメソッド[1]

CIWStateException[1]

CIWTransientException[1]

CIWTransientException直系の既知のサブクラス[1]

CIWTransitionFailedException[1]

CIWUserException[1]

CIWUserException（ユーザエラーメッセージ）[1]

CIWUserException（ユーザエラーメッセージおよびエラー原因）[1]

CIWUserExceptionの引数（ユーザエラーメッセージ）[1]

CIWUserExceptionの引数（ユーザエラーメッセージおよびエラー原因）[1]

CIWUtil[1]

CIWUtil.InfinityDate[1]

CIWUtil.InfinityDateのメソッド[1]

CIWUtil.InfinityDateの列挙型定数[1]

CIWUtilクラスのメソッド[1]

CIWUtilの入れ子のクラス[1]

CIWWorkApplication[1]

CIWWorkApplication.Parameter[1]

CIWWorkApplication.Parameterのメソッド[1]

CIWWorkApplication.Parameterの列挙型定数[1]

CIWWorkApplication.Result[1]

CIWWorkApplication.Resultのメソッド[1]

CIWWorkApplication.Resultの列挙型定数[1]

CIWWorkApplicationインタフェースのメソッド[1]

CIWWorkApplicationの入れ子のクラス[1]

CIWWorkDefinition[1]

CIWWorkDefinition.AttributeName[1]

CIWWorkDefinition.AttributeNameのメソッド[1]

CIWWorkDefinition.AttributeNameの列挙型定数[1]

CIWWorkDefinition.Type[1]

CIWWorkDefinition.Typeのメソッド[1]

CIWWorkDefinition.Typeの列挙型定数[1]

CIWWorkDefinitionインタフェースの入れ子のクラス[1]

CIWWorkDefinitionインタフェースのメソッド[1]

CIWWorkItem[1]

CIWWorkItem.AttributeName[1]

CIWWorkItem.AttributeNameのメソッド[1]

CIWWorkItem.AttributeNameの列挙型定数[1]

CIWWorkItem.State[1]

CIWWorkItem.Stateのメソッド[1]

CIWWorkItem.Stateの列挙型定数[1]

CIWWorkItem.Type[1]

CIWWorkItem.Typeのメソッド[1]

CIWWorkItem.Typeの列挙型定数[1]

CIWWorkItemインタフェースの入れ子のクラス[1]

CIWWorkItemインタフェースのメソッド[1]

complete〔CIWWorkItem〕[1]

completeで発生する例外〔CIWWorkItem〕[1]

convertDateToString〔CIWUtil〕[1]、[2]

convertDateToStringの引数〔CIWUtil〕[1]、[2]

createAndStartProcessInstance〔CIWServer〕[1]

createAndStartProcessInstanceで発生する例外〔CIWServer〕[1]

createAndStartProcessInstanceの引数〔CIWServer〕[1]

createCIWServer〔CIWFactory〕[1]

createCIWServer〔CIWFactory（javax.sql.DataSource）〕[1]

createCIWServerで発生する例外〔CIWFactory〕[1]

createCIWServerで発生する例外〔CIWFactory（javax.sql.DataSource）〕[1]

createCIWServerの引数〔CIWFactory〕[1]

createCIWServerの引数〔CIWFactory（javax.sql.DataSource）〕[1]

createProcessInstance〔CIWServer〕[1]

createProcessInstanceで発生する例外〔CIWServer〕[1]

createProcessInstanceの引数〔CIWServer〕[1]

CSCIWManagementServerを停止した状態でのAPI実行について〔API利用時の注意事項〕[1]

CSCIWで管理するトランザクション[1]

CSCIWで使用するビジネスプロセス定義と振り分けルール定義の開発[1]

CSCIWの終了[1]

CSCIWの初期化[1]

CSCIWの初期化，終了処理をするクラス[1]

CSCIWを利用した業務処理の実装[1]

D

DBMSの一時的な障害発生の場合[1]

DBMSの障害発生の場合[1]

delete〔CIWProcessInstance〕[1]

deleteで発生する例外〔CIWProcessInstance〕[1]

detachDatabaseConnection〔CIWConnectionCoordinator〕[1]

E

evaluate〔CIWActivityInstance〕[1]

evaluate〔CIWWorkItem〕[1]

evaluateCondition〔CIWConditionEvaluator〕[1]

evaluateConditionの引数[1]

evaluateCreationRule〔CIWCreationRuleEvaluator〕[1]

evaluateCreationRuleの引数[1]

evaluateで発生する例外〔CIWActivityInstance〕[1]

evaluateで発生する例外〔CIWWorkItem〕[1]

F

finalize()メソッド内での使用について〔API利用時の注意事項〕[1]

finalizeCIWFactory〔CIWAdmin〕[1]

free〔CIWWorkItem〕[1]

freeで発生する例外〔CIWWorkItem〕[1]

fromStateCode〔CIWActivityInstance.State〕[1]

fromStateCode〔CIWProcessDefinition.State〕[1]

fromStateCode〔CIWProcessInstance.State〕[1]

fromStateCode〔CIWWorkItem.State〕[1]

fromStateCodeで発生する例外〔CIWWorkItem.State〕[1]

fromStateCodeの引数〔CIWActivityInstance.State〕[1]

fromStateCodeの引数〔CIWProcessDefinition.State〕[1]

fromStateCodeの引数〔CIWProcessInstance.State〕[1]

fromStateCodeの引数〔CIWWorkItem.State〕[1]

fromStateCodeの例外〔CIWActivityInstance.State〕[1]

fromStateCodeの例外〔CIWProcessDefinition.State〕[1]

fromStateCodeの例外〔CIWProcessInstance.State〕[1]

fromTypeCode〔CIWActivityInstance.Type〕[1]

fromTypeCode〔CIWWorkDefinition.Type〕[1]

fromTypeCode〔CIWWorkItem.Type〕[1]

fromTypeCodeで発生する例外〔CIWWorkDefinition.Type〕[1]

fromTypeCodeで発生する例外〔CIWWorkItem.Type〕[1]

fromTypeCodeの引数〔CIWActivityInstance.Type〕[1]

fromTypeCodeの引数〔CIWWorkDefinition.Type〕[1]

fromTypeCodeの引数〔CIWWorkItem.Type〕[1]

fromTypeCodeの例外〔CIWActivityInstance.Type〕[1]

G

getActivityDefinitionID〔CIWActivityInstance〕[1]

getActivityDefinitionID〔CIWWorkDefinition〕[1]

getActivityDefinitionIDで発生する例外〔CIWActivityInstance〕[1]

getActivityDefinitionIDで発生する例外〔CIWWorkDefinition〕[1]

getActivityDefinitionName〔CIWActivityInstance〕[1]

getActivityDefinitionNameで発生する例外〔CIWActivityInstance〕[1]、[2]

getActivityInstance〔CIWServer〕[1]

getActivityInstanceID〔CIWWorkItem〕[1]

getActivityInstanceIDで発生する例外〔CIWWorkItem〕[1]

getActivityInstancesList〔CIWServer〕[1]

getActivityInstancesListで発生する例外〔CIWServer〕[1]

getActivityInstancesListの引数〔CIWServer〕[1]

getActivityInstanceで発生する例外〔CIWServer〕[1]

getActivityInstanceの引数〔CIWServer〕[1]

getAuthor〔CIWProcessDefinition〕[1]

getAuthorで発生する例外〔CIWProcessDefinition〕[1]

getAvailableParticipant〔CIWResourceSelector〕[1]

getAvailableParticipantの引数[1]

getCastingRuleName〔CIWWorkDefinition〕[1]

getCastingRuleNameで発生する例外〔CIWWorkDefinition〕[1]

getCause〔CIWSQLException〕[1]

getCause〔CIWSQLTransientException〕[1]

getClosedDate〔CIWActivityInstance〕[1]

getClosedDate〔CIWProcessInstance〕[1]

getClosedDate〔CIWWorkItem〕[1]

getClosedDateで発生する例外〔CIWActivityInstance〕[1]

getClosedDateで発生する例外〔CIWProcessInstance〕[1]

getClosedDateで発生する例外〔CIWWorkItem〕[1]

getConnectionCoordinator〔CIWServer〕[1]

getConnectionCoordinatorで発生する例外〔CIWServer〕[1]

getCreationDate〔CIWProcessDefinition〕[1]

getCreationDate〔CIWWorkItem〕[1]

getCreationDateで発生する例外〔CIWProcessDefinition〕[1]

getCreationDateで発生する例外〔CIWWorkItem〕[1]

getCreator〔CIWProcessInstance〕[1]

getCreatorで発生する例外〔CIWProcessInstance〕[1]

getDeadline〔CIWActivityInstance〕[1]

getDeadline〔CIWProcessInstance〕[1]

getDeadline〔CIWWorkItem〕[1]

getDeadlineで発生する例外〔CIWActivityInstance〕[1]

getDeadlineで発生する例外〔CIWProcessInstance〕[1]

getDeadlineで発生する例外〔CIWWorkItem〕[1]

getDescription〔CIWProcessDefinition〕[1]

getDescription〔CIWWorkDefinition〕[1]

getDescriptionで発生する例外〔CIWProcessDefinition〕[1]

getDescriptionで発生する例外〔CIWWorkDefinition〕[1]

getErrorCode〔CIWSQLException〕[1]

getErrorCode〔CIWSQLTransientException〕[1]

getID〔CIWActivityInstance〕[1]

getID〔CIWProcessDefinition〕[1]

getID〔CIWProcessInstance〕[1]

getID〔CIWWorkDefinition〕[1]

getID〔CIWWorkItem〕[1]

getIDで発生する例外〔CIWActivityInstance〕[1]

getIDで発生する例外〔CIWProcessDefinition〕[1]

getIDで発生する例外〔CIWProcessInstance〕[1]

getIDで発生する例外〔CIWWorkDefinition〕[1]

getIDで発生する例外〔CIWWorkItem〕[1]

getInstance〔CIWFactory〕[1]

getInstanceで発生する例外〔CIWFactory〕[1]

getListCount〔CIWServer〕[1]

getListCountで発生する例外〔CIWServer〕[1]

getListCountの引数〔CIWServer〕[1]

getMovedDate〔CIWProcessInstance〕[1]

getMovedDateで発生する例外〔CIWProcessInstance〕[1]

getName〔CIWActivityInstance〕[1]

getName〔CIWProcessDefinition〕[1]

getName〔CIWProcessInstance〕[1]

getName〔CIWWorkDefinition〕[1]

getName〔CIWWorkItem〕[1]

getNameで発生する例外〔CIWActivityInstance〕[1]

getNameで発生する例外〔CIWProcessDefinition〕[1]

getNameで発生する例外〔CIWProcessInstance〕[1]

getNameで発生する例外〔CIWWorkDefinition〕[1]

getNameで発生する例外〔CIWWorkItem〕[1]

getParentProcessInstance〔CIWWorkItem〕[1]

getParentProcessInstanceで発生する例外〔CIWWorkItem〕[1]

getParentProcessInstanceの引数〔CIWWorkItem〕[1]

getParticipant〔CIWWorkItem〕[1]

getParticipantで発生する例外〔CIWWorkItem〕[1]

getPriority〔CIWActivityInstance〕[1]

getPriority〔CIWProcessInstance〕[1]

getPriority〔CIWWorkItem〕[1]

getPriorityで発生する例外〔CIWActivityInstance〕[1]

getPriorityで発生する例外〔CIWProcessInstance〕[1]

getPriorityで発生する例外〔CIWWorkItem〕[1]

getProcessDefinition〔CIWProcessInstance〕[1]

getProcessDefinition〔CIWServer〕[1]

getProcessDefinitionID〔CIWActivityInstance〕[1]

getProcessDefinitionID〔CIWProcessInstance〕[1]

getProcessDefinitionID〔CIWWorkDefinition〕[1]

getProcessDefinitionID〔CIWWorkItem〕[1]

getProcessDefinitionIDで発生する例外〔CIWActivityInstance〕[1]

getProcessDefinitionIDで発生する例外〔CIWProcessInstance〕[1]

getProcessDefinitionIDで発生する例外〔CIWWorkDefinition〕[1]

getProcessDefinitionIDで発生する例外〔CIWWorkItem〕[1]

getProcessDefinitionName〔CIWProcessInstance〕[1]

getProcessDefinitionNameで発生する例外〔CIWProcessInstance〕[1]

getProcessDefinitionsList〔CIWServer〕[1]

getProcessDefinitionsListで発生する例外〔CIWServer〕[1]

getProcessDefinitionsListの引数〔CIWServer〕[1]

getProcessDefinitionで発生する例外〔CIWProcessInstance〕[1]

getProcessDefinitionで発生する例外〔CIWServer〕[1]

getProcessDefinitionの引数〔CIWProcessInstance〕[1]

getProcessDefinitionの引数〔CIWServer〕[1]

getProcessInstance〔CIWServer〕[1]

getProcessInstanceID〔CIWActivityInstance〕[1]

getProcessInstanceID〔CIWWorkItem〕[1]

getProcessInstanceIDで発生する例外〔CIWActivityInstance〕[1]

getProcessInstanceIDで発生する例外〔CIWWorkItem〕[1]

getProcessInstanceName〔CIWActivityInstance〕[1]

getProcessInstanceName〔CIWWorkItem〕[1]

getProcessInstanceNameで発生する例外〔CIWActivityInstance〕[1]

getProcessInstanceNameで発生する例外〔CIWWorkItem〕[1]

getProcessInstancesList〔CIWProcessDefinition〕[1]

getProcessInstancesList〔CIWServer〕[1]

getProcessInstancesListで発生する例外〔CIWProcessDefinition〕[1]

getProcessInstancesListで発生する例外〔CIWServer〕[1]

getProcessInstancesListの引数〔CIWProcessDefinition〕[1]

getProcessInstancesListの引数〔CIWServer〕[1]

getProcessInstanceで発生する例外〔CIWServer〕[1]

getProcessInstanceの引数〔CIWServer〕[1]

getResponsible〔CIWProcessDefinition〕[1]

getResponsibleで発生する例外〔CIWProcessDefinition〕[1]

getSQLState〔CIWSQLException〕[1]

getSQLState〔CIWSQLTransientException〕[1]

getStartDate〔CIWActivityInstance〕[1]

getStartDate〔CIWProcessInstance〕[1]

getStartDate〔CIWWorkItem〕[1]

getStartDateで発生する例外〔CIWActivityInstance〕[1]

getStartDateで発生する例外〔CIWProcessInstance〕[1]

getStartDateで発生する例外〔CIWWorkItem〕[1]

getState〔CIWActivityInstance〕[1]

getState〔CIWProcessDefinition〕[1]

getState〔CIWProcessInstance〕[1]

getState〔CIWWorkItem〕[1]

getStateで発生する例外〔CIWActivityInstance〕[1]

getStateで発生する例外〔CIWProcessDefinition〕[1]

getStateで発生する例外〔CIWProcessInstance〕[1]

getStateで発生する例外〔CIWWorkItem〕[1]

getType〔CIWActivityInstance〕[1]

getType〔CIWWorkDefinition〕[1]

getType〔CIWWorkItem〕[1]

getTypeで発生する例外〔CIWWorkDefinition〕[1]

getTypeで発生する例外〔CIWWorkItem〕[1]

getValidFromDate〔CIWProcessDefinition〕[1]

getValidFromDateで発生する例外〔CIWProcessDefinition〕[1]

getValidToDate〔CIWProcessDefinition〕[1]

getValidToDateで発生する例外〔CIWProcessDefinition〕[1]

getVersion〔CIWProcessDefinition〕[1]

getVersionで発生する例外〔CIWProcessDefinition〕[1]

getWorkDefinition〔CIWServer〕[1]

getWorkDefinition〔CIWWorkItem〕[1]

getWorkDefinitionID〔CIWWorkItem〕[1]

getWorkDefinitionIDで発生する例外〔CIWWorkItem〕[1]

getWorkDefinitionName〔CIWWorkItem〕[1]

getWorkDefinitionNameで発生する例外〔CIWWorkItem〕[1]

getWorkDefinitionsList〔CIWServer〕[1]

getWorkDefinitionsListで発生する例外〔CIWServer〕[1]

getWorkDefinitionsListの引数〔CIWServer〕[1]

getWorkDefinitionで発生する例外〔CIWServer〕[1]

getWorkDefinitionで発生する例外〔CIWWorkItem〕[1]

getWorkDefinitionの引数〔CIWServer〕[1]

getWorkDefinitionの引数〔CIWWorkItem〕[1]

getWorkItem〔CIWServer〕[1]

getWorkItemsList〔CIWProcessInstance〕[1]

getWorkItemsList〔CIWServer〕[1]

getWorkItemsListで発生する例外〔CIWProcessInstance〕[1]

getWorkItemsListで発生する例外〔CIWServer〕[1]

getWorkItemsListの引数〔CIWProcessInstance〕[1]

getWorkItemsListの引数〔CIWServer〕[1]

getWorkItemで発生する例外〔CIWServer〕[1]

getWorkItemの引数〔CIWServer〕[1]

I

initializeCIWFactory〔CIWAdmin〕[1]

initializeCIWFactoryで発生する例外[1]

initializeCIWFactoryの引数[1]

isClosed〔CIWActivityInstance.State〕[1]

isClosed〔CIWProcessInstance.State〕[1]

isClosed〔CIWWorkItem.State〕[1]

isCompleted〔CIWActivityInstance.State〕[1]

isCompleted〔CIWWorkItem.State〕[1]

isExecuted〔CIWActivityInstance.State〕[1]

isNotRunning〔CIWActivityInstance.State〕[1]

isNotRunning〔CIWProcessInstance.State〕[1]

isNotRunning〔CIWWorkItem.State〕[1]

isNotStarted〔CIWActivityInstance.State〕[1]

isNotStarted〔CIWWorkItem.State〕[1]

isOpen〔CIWActivityInstance.State〕[1]

isOpen〔CIWProcessInstance.State〕[1]

isOpen〔CIWWorkItem.State〕[1]

isRunning〔CIWWorkItem.State〕[1]

isSuspended〔CIWActivityInstance.State〕[1]

isSuspended〔CIWProcessInstance.State〕[1]

isSuspended〔CIWWorkItem.State〕[1]

J

J2EEサーバで使用する場合〔CSCIWの終了〕[1]

Javaアプリケーションで使用する場合〔CSCIWの終了〕[1]

Javaアプリケーションで使用する場合〔CSCIWの初期化〕[1]

Javaオブジェクトに渡される情報（作業アプリケーションの場合）[1]

Javaオブジェクトに渡される情報（条件，生成ルールおよび振り分けルールの場合）[1]

Javaオブジェクトの作成[1]

Javaオブジェクトの実装例（作業アプリケーション）[1]

Javaオブジェクトの実装例（条件，生成ルール，および振り分けルール）[1]

Javaオブジェクト呼び出し時にエラーが発生した場合[1]

Javaオブジェクト呼び出しとコネクションの関連づけ[1]

Javaオブジェクト呼び出し用のインタフェース[1]

Javaオブジェクト呼び出し利用時の設定[1]

Java業務プログラムの作成[1]

Javaコンパイラのオプション[1]

M

makeBackwardTransition〔CIWActivityInstance〕[1]

makeBackwardTransitionで発生する例外〔CIWActivityInstance〕[1]

makeBackwardTransitionの引数〔CIWActivityInstance〕[1]

P

performAndComplete〔CIWWorkItem〕[1]

performAndCompleteで発生する例外〔CIWWorkItem〕[1]

perform〔CIWWorkItem〕[1]

performで発生する例外〔CIWWorkItem〕[1]

R

reassignAndPerform〔CIWWorkItem〕[1]

reassignAndPerformで発生する例外〔CIWWorkItem〕[1]

reassignAndPerformの引数〔CIWWorkItem〕[1]

reassign〔CIWWorkItem〕[1]

reassignで発生する例外〔CIWWorkItem〕[1]

reassignの引数〔CIWWorkItem〕[1]

reevaluateCastingRule〔CIWWorkItem〕[1]

reevaluateCastingRuleで発生する例外〔CIWWorkItem〕[1]

S

setDeadline〔CIWActivityInstance〕[1]

setDeadline〔CIWProcessInstance〕[1]

setDeadline〔CIWWorkItem〕[1]

setDeadlineで発生する例外〔CIWActivityInstance〕[1]

setDeadlineで発生する例外〔CIWProcessInstance〕[1]

setDeadlineで発生する例外〔CIWWorkItem〕[1]

setDeadlineの引数〔CIWActivityInstance〕[1]

setDeadlineの引数〔CIWProcessInstance〕[1]

setDeadlineの引数〔CIWWorkItem〕[1]

setPriority〔CIWActivityInstance〕[1]

setPriority〔CIWProcessInstance〕[1]

setPriority〔CIWWorkItem〕[1]

setPriorityで発生する例外〔CIWActivityInstance〕[1]

setPriorityで発生する例外〔CIWProcessInstance〕[1]

setPriorityで発生する例外〔CIWWorkItem〕[1]

setPriorityの引数〔CIWActivityInstance〕[1]

setPriorityの引数〔CIWProcessInstance〕[1]

setPriorityの引数〔CIWWorkItem〕[1]

startAndAdhocInstantiateActivityInstanceByADName〔CIWProcessInstance〕[1]

startAndAdhocInstantiateActivityInstanceByADNameで発生する例外〔CIWProcessInstance〕[1]

startAndAdhocInstantiateActivityInstanceByADNameの引数〔CIWProcessInstance〕[1]

start〔CIWProcessInstance〕[1]

startSynchronously〔CIWWorkApplication〕[1]

startSynchronouslyの引数[1]

startで発生する例外〔CIWProcessInstance〕[1]

State属性で指定できる値[1]、[2]

T

terminate〔CIWProcessInstance〕[1]

terminateで発生する例外〔CIWProcessInstance〕[1]

toAttributeName〔CIWActivityInstance.AttributeName〕[1]

toAttributeName〔CIWProcessDefinition.AttributeName〕[1]

toAttributeName〔CIWProcessInstance.AttributeName〕[1]

toAttributeName〔CIWWorkDefinition.AttributeName〕[1]

toAttributeName〔CIWWorkItem.AttributeName〕[1]

toDate〔CIWUtil.InfinityDate〕[1]

toParameterName〔CIWConditionEvaluator.Parameter〕[1]

toParameterName〔CIWCreationRuleEvaluator.Parameter〕[1]

toParameterName〔CIWResourceSelector.Parameter〕[1]

toParameterName〔CIWWorkApplication.Parameter〕[1]

toShortState〔CIWActivityInstance.State〕[1]

toShortState〔CIWProcessDefinition.State〕[1]

toShortState〔CIWProcessInstance.State〕[1]

toShortState〔CIWWorkItem.State〕[1]

toState〔CIWActivityInstance.State〕[1]

toState〔CIWProcessDefinition.State〕[1]

toState〔CIWProcessInstance.State〕[1]

toState〔CIWWorkItem.State〕[1]

toStateCode〔CIWActivityInstance.State〕[1]

toStateCode〔CIWProcessDefinition.State〕[1]

toStateCode〔CIWProcessInstance.State〕[1]

toStateCode〔CIWWorkItem.State〕[1]

toString〔CIWActivityInstance.State〕[1]

toString〔CIWActivityInstance.Type〕[1]

toString〔CIWProcessDefinition.State〕[1]

toString〔CIWProcessInstance.State〕[1]

toString〔CIWWorkDefinition.Type〕[1]

toString〔CIWWorkItem.State〕[1]

toString〔CIWWorkItem.Type〕[1]

toTargetkind〔CIWServer.Targetkind〕[1]

toType〔CIWActivityInstance.Type〕[1]

toType〔CIWWorkDefinition.Type〕[1]

toType〔CIWWorkItem.Type〕[1]

toTypeCode〔CIWActivityInstance.Type〕[1]

toTypeCode〔CIWWorkDefinition.Type〕[1]

toTypeCode〔CIWWorkItem.Type〕[1]

Type属性で指定できる値[1]、[2]

V

valueOf〔CIWActivityInstance.AttributeName〕[1]

valueOf〔CIWActivityInstance.State〕[1]

valueOf〔CIWActivityInstance.Type〕[1]

valueOf〔CIWConditionEvaluator.Parameter〕[1]

valueOf〔CIWCreationRuleEvaluator.Parameter〕[1]

valueOf〔CIWProcessDefinition.AttributeName〕[1]

valueOf〔CIWProcessDefinition.State〕[1]

valueOf〔CIWProcessInstance.AttributeName〕[1]

valueOf〔CIWProcessInstance.State〕[1]

valueOf〔CIWResourceSelector.Parameter〕[1]

valueOf〔CIWServer.Targetkind〕[1]

valueOf〔CIWUtil.InfinityDate〕[1]

valueOf〔CIWWorkApplication.Parameter〕[1]

valueOf〔CIWWorkApplication.Result〕[1]

valueOf〔CIWWorkDefinition.AttributeName〕[1]

valueOf〔CIWWorkDefinition.Type〕[1]

valueOf〔CIWWorkItem.AttributeName〕[1]

valueOf〔CIWWorkItem.State〕[1]

valueOf〔CIWWorkItem.Type〕[1]

valueOfで発生する例外〔CIWActivityInstance.AttributeName〕[1]

valueOfで発生する例外〔CIWActivityInstance.State〕[1]

valueOfで発生する例外〔CIWActivityInstance.Type〕[1]

valueOfで発生する例外〔CIWConditionEvaluator.Parameter〕[1]

valueOfで発生する例外〔CIWCreationRuleEvaluator.Parameter〕[1]

valueOfで発生する例外〔CIWProcessDefinition.AttributeName〕[1]

valueOfで発生する例外〔CIWProcessDefinition.State〕[1]

valueOfで発生する例外〔CIWProcessInstance.AttributeName〕[1]

valueOfで発生する例外〔CIWProcessInstance.State〕[1]

valueOfで発生する例外〔CIWResourceSelector.Parameter〕[1]

valueOfで発生する例外〔CIWServer.Targetkind〕[1]

valueOfで発生する例外〔CIWUtil.InfinityDate〕[1]

valueOfで発生する例外〔CIWWorkApplication.Parameter〕[1]

valueOfで発生する例外〔CIWWorkApplication.Result〕[1]

valueOfで発生する例外〔CIWWorkDefinition.AttributeName〕[1]

valueOfで発生する例外〔CIWWorkDefinition.Type〕[1]

valueOfで発生する例外〔CIWWorkItem.AttributeName〕[1]

valueOfで発生する例外〔CIWWorkItem.State〕[1]

valueOfで発生する例外〔CIWWorkItem.Type〕[1]

valueOfの引数〔CIWActivityInstance.AttributeName〕[1]

valueOfの引数〔CIWActivityInstance.State〕[1]

valueOfの引数〔CIWActivityInstance.Type〕[1]

valueOfの引数〔CIWConditionEvaluator.Parameter〕[1]

valueOfの引数〔CIWCreationRuleEvaluator.Parameter〕[1]

valueOfの引数〔CIWProcessDefinition.AttributeName〕[1]

valueOfの引数〔CIWProcessDefinition.State〕[1]

valueOfの引数〔CIWProcessInstance.AttributeName〕[1]

valueOfの引数〔CIWProcessInstance.State〕[1]

valueOfの引数〔CIWResourceSelector.Parameter〕[1]

valueOfの引数〔CIWServer.Targetkind〕[1]

valueOfの引数〔CIWUtil.InfinityDate〕[1]

valueOfの引数〔CIWWorkApplication.Parameter〕[1]

valueOfの引数〔CIWWorkApplication.Result〕[1]

valueOfの引数〔CIWWorkDefinition.AttributeName〕[1]

valueOfの引数〔CIWWorkDefinition.Type〕[1]

valueOfの引数〔CIWWorkItem.AttributeName〕[1]

valueOfの引数〔CIWWorkItem.State〕[1]

valueOfの引数〔CIWWorkItem.Type〕[1]

values〔CIWActivityInstance.AttributeName〕[1]

values〔CIWActivityInstance.State〕[1]

values〔CIWActivityInstance.Type〕[1]

values〔CIWConditionEvaluator.Parameter〕[1]

values〔CIWCreationRuleEvaluator.Parameter〕[1]

values〔CIWProcessDefinition.AttributeName〕[1]

values〔CIWProcessDefinition.State〕[1]

values〔CIWProcessInstance.AttributeName〕[1]

values〔CIWProcessInstance.State〕[1]

values〔CIWResourceSelector.Parameter〕[1]

values〔CIWServer.Targetkind〕[1]

values〔CIWUtil.InfinityDate〕[1]

values〔CIWWorkApplication.Parameter〕[1]

values〔CIWWorkApplication.Result〕[1]

values〔CIWWorkDefinition.AttributeName〕[1]

values〔CIWWorkDefinition.Type〕[1]

values〔CIWWorkItem.AttributeName〕[1]

values〔CIWWorkItem.State〕[1]

values〔CIWWorkItem.Type〕[1]

W

WorkCoordinator Definerで作成された定義ファイルの利用[1]

あ

案件実行・運用クラスおよびインタフェースが提供するメソッド[1]

案件実行・運用クラスおよびインタフェースの一覧[1]

案件実行・運用クラスおよびインタフェースの階層[1]

案件処理中のエラーの場合[1]

案件属性[1]

案件属性一覧[1]

案件属性の属性名の列挙型[1]

案件のインタフェース[1]

案件の状態[1]

案件の状態一覧[1]

案件の状態遷移[1]、[2]

案件の状態の列挙型[1]

案件の遷移[1]

案件の遷移一覧[1]

案件の遷移時に設定する属性一覧[1]

案件の投入〔CSCIWを利用した業務処理の実装〕[1]

い

一時的な障害発生の場合[1]

一覧情報取得時のCSCIW内での動作[1]

一覧情報取得時の最大取得件数の指定[1]

一覧情報取得時のソート条件[1]

一覧情報取得時のフィルター条件[1]

一覧情報の取得[1]

一覧情報の取得手順[1]

一覧情報の取得手順と基本動作[1]

インタフェースの一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

インタフェースの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

インタフェースの階層（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

インタフェースの階層（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

え

エラーが発生した場合のトランザクションの終了について〔API利用時の注意事項〕[1]

お

オブジェクトの取得で指定できる値[1]

オブジェクトのリストの取得で指定できる値[1]

か

各種ユーティリティ機能を提供するクラス[1]

き

記述形式[1]、[2]、[3]、[4]

記述形式（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]、[2]

記述形式（パッケージ「jp.co.Hitachi.soft.csciw」）[1]、[2]

業務ステップ属性[1]

業務ステップ属性一覧[1]

業務ステップ属性の属性名の列挙型[1]

業務ステップのインタフェース[1]

業務ステップの種類の列挙型[1]

業務ステップの状態[1]

業務ステップの状態一覧[1]

業務ステップの状態遷移[1]、[2]

業務ステップの状態の列挙型[1]

業務ステップの遷移[1]

業務ステップの遷移一覧[1]

業務ステップの遷移時に設定する属性一覧[1]

業務プログラムで管理するトランザクション[1]

業務プログラムとデータベース間での文字コード[1]

業務プログラムに渡される情報[1]

業務プログラムのコーディング例〔CIWFactoryオブジェクトの取得〕[1]

業務プログラムのコーディング例〔CIWServerオブジェクトに対するConnectionオブジェクトの関連づけ〕[1]

業務プログラムのコーディング例〔CIWServerオブジェクトに対するConnectionオブジェクトの関連づけの解除〕[1]

業務プログラムのコーディング例〔CIWServerオブジェクトの生成（コネクションと関連づける場合）〕[1]

業務プログラムのコーディング例〔CIWServerオブジェクトの生成（データソースと関連づける場合）〕[1]

業務プログラムのコーディング例〔CSCIWの終了（Javaアプリケーションで使用する場合）〕[1]

業務プログラムのコーディング例〔CSCIWの初期化〕[1]

業務プログラムのコーディング例〔CSCIWを利用した業務処理の実装（案件の投入）〕[1]

業務プログラムのコーディング例〔CSCIWを利用した業務処理の実装（作業一覧の取得）〕[1]

業務プログラムのコーディング例〔CSCIWを利用した業務処理の実装（作業の開始と終了）〕[1]

業務プログラムのコンパイル[1]

業務プログラムの作成方法[1]

業務プログラムの処理の流れ[1]

く

組み込み変数[1]

クラスの一覧[1]

クラスの構成[1]

クラスパス[1]

こ

更新系API[1]

更新系API一覧[1]

更新系APIで指定できる値[1]

さ

作業アプリケーションJavaオブジェクトのインタフェース[1]

作業アプリケーションに渡される情報[1]

作業アプリケーションに渡されるパラメタの列挙型[1]

作業アプリケーションの業務処理結果の列挙型[1]

作業アプリケーションを作成するときの注意事項[1]

作業一覧の取得〔CSCIWを利用した業務処理の実装〕[1]

作業属性[1]

作業属性一覧[1]

作業属性の属性名の列挙型[1]

作業定義属性[1]

作業定義属性一覧[1]

作業定義属性の属性名の列挙型[1]

作業定義のインタフェース[1]

作業定義の種類の列挙型[1]

作業のインタフェース[1]

作業の開始と終了〔CSCIWを利用した業務処理の実装〕[1]

作業の種類の列挙型[1]

作業の状態[1]

作業の状態一覧[1]

作業の状態遷移[1]、[2]

作業の状態の列挙型[1]

作業の遷移[1]

作業の遷移一覧[1]

作業の遷移時に設定する属性一覧[1]

作成時の注意事項〔Javaオブジェクト〕[1]

参照系API[1]

参照系API一覧[1]

参照系APIで指定できる属性[1]

参照系APIの使用について[1]

し

指定できる属性一覧[1]

指定できる属性〔ソート条件〕[1]

指定できる属性値[1]

指定できる属性〔フィルター条件〕[1]

指定できるデータ[1]

指定方法〔ソート条件〕[1]

指定方法〔フィルター条件〕[1]

巡回部分を含むビジネスプロセス定義[1]

障害発生の場合[1]

条件Javaオブジェクトのインタフェース[1]

条件およびルールの評価[1]

条件定義，生成ルール定義，または振り分けルール定義に指定できる種別[1]

条件に一致する作業の作業者割り当てと着手をする場合の実装例[1]

条件に渡されるパラメタの列挙型[1]

条件またはルールの評価に渡される情報[1]

状態遷移モデル[1]

初期化・終了クラスが提供するメソッド[1]

初期化・終了クラスの一覧[1]

初期化・終了クラスの階層[1]

処理するオブジェクトが存在しない場合[1]

す

スレッドからの利用について〔API利用時の注意事項〕[1]

せ

生成ルールJavaオブジェクトのインタフェース[1]

生成ルールに渡されるパラメタの列挙型[1]

そ

属性値の指定方法〔フィルター条件〕[1]

その他の階層[1]

その他のクラス[1]

その他のクラス一覧[1]

その他のクラスで指定できる値[1]

ち

注意事項〔ソート条件〕[1]

注意事項〔フィルター条件〕[1]

て

提供API一覧[1]

データソースと関連づける場合〔CIWServerオブジェクトの生成〕[1]

データソースを使用したConnectionオブジェクトの関連づけ〔業務プログラムで管理するトランザクション（CIWServerとコネクションの関連づけ）〕[1]

と

トランザクションの開始〔業務プログラムで管理するトランザクション〕[1]

トランザクションの終了〔業務プログラムで管理するトランザクション〕[1]

は

排他およびデッドロックについて〔API利用時の注意事項〕[1]

パッケージのインポート[1]

パッケージ「jp.co.Hitachi.soft.csciw.callback」に所属するクラス[1]

パッケージ「jp.co.Hitachi.soft.csciw.callback」の階層[1]

パッケージ「jp.co.Hitachi.soft.csciw」に所属するクラス[1]

パッケージ「jp.co.Hitachi.soft.csciw」の階層[1]

ひ

ビジネスプロセス定義属性[1]

ビジネスプロセス定義属性一覧[1]

ビジネスプロセス定義属性の属性名の列挙型[1]

ビジネスプロセス定義のインタフェース[1]

ビジネスプロセス定義の状態の列挙型[1]

ビジネスプロセスの開発方法[1]

ビジネスプロセスの変更[1]

ビジネスプロセスを定義するときの注意事項[1]

ふ

不正な状態の場合[1]

振り分けルールJavaオブジェクトのインタフェース[1]

振り分けルールに渡されるパラメタの列挙型[1]

む

無限遠の日付の列挙型[1]

れ

例外クラス（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

例外クラス（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

例外クラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

例外クラスの一覧（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

例外クラスの階層（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

例外クラスの階層（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

例外の基底の抽象クラス[1]

列挙型（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

列挙型（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

列挙型の一覧（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

列挙型の一覧（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

列挙型の階層（パッケージ「jp.co.Hitachi.soft.csciw.callback」）[1]

列挙型の階層（パッケージ「jp.co.Hitachi.soft.csciw」）[1]

わ

ワーク管理システムが管理するオブジェクトの種別を表す列挙型[1]

ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェース[1]