QueueHelperSample
このクラスは、他のサンプルまたはアプリケーション、特に QueueSample のための再利用可能なメソッドを持つヘルパー・クラスです。このサンプルは、キュー情報を取得し、さまざまなキュー関連オブジェクトに関して報告する方法を示します。
詳細については、サンプル・ソースのコメントを参照してください。サンプルは、IBM® FileNet® P8 Platform 資料ライブラリーの『Developer samples』セクションにあります。
「API サンプルの実行」も参照してください。
メソッド
QueueHelper メソッドの一般的な説明を以下に示します。
displayQueueContents()
キューの内容、すなわち、キュー・エレメント、ステップ・エレメント、およびワーク・オブジェクトのプロパティーを表示します。このメソッドは、ローカル・メソッドである displayQueueElements()、displayStepElements()、および displayWorkObjects() を使用してキュー情報を取得します。
displayQueueElementInfo()
単一のキュー・エレメントのプロパティーを以下の手順で表示します。
VWQueueElement.getUserDefinedFieldNames を使用して、フィールド名配列が設定されます。
VWQueueElement.getWorkObjectNumber を使用して、キュー・エレメントのプロパティーが個別にログに記録されます。
VWQueueElement メソッドである getWorkClassName()、getQueueName()、getOperationName()、getLockedStatus()、および getLockedMachine() を使用して追加のプロパティー値が取得され、結果がログに記録されます。
displayQueueElements()
VWQueue.createQuery を使用して VWQueueQuery オブジェクトを取得し、VWQueueQuery.next を使用して一連のすべてのキュー・エレメントへの照会を実行します。ローカル・メソッド displayQueueElementInfo() を使用して、キュー・エレメント情報を表示します。
displayQueueLockStatus()
すべてのワークフロー・キュー・エレメントのロック状況情報を表示し、キュー名をログに記録します。
displayQueueLockStatus() は、displayQueueElements() と同様にすべてのキュー・エレメントへの照会を実行しますが、VWQueueQuery.next() によってループを制御する点が異なります。VWQueueElement.getLockedUser を使用してロックされたワーク・オブジェクトを検索し、VWQueueElement.getWorkObjectNumber を使用してワーク・オブジェクト番号を取得します。
displayQueueNames()
VWQueueElement.getQueueName を使用して、すべてのキュー名をログに記録します。
displayStepElements() and displayWorkObjects()
この 2 つのメソッドは、キュー・エレメント、ステップ・エレメント、またはワーク・オブジェクトのグループに関するプロパティー情報を表示します。これらのメソッドが使用する処理手順はほぼ同様で、まず、VWQueue.createQuery を使用してエレメント・グループまたはオブジェクト・グループの反復照会をセットアップし、該当の VWFetchType 定数を指定して VWQueueQuery オブジェクトを取得し、VWQueueQuery.next を使用してエレメント・グループまたはオブジェクト・グループを反復処理します。
getQueue()
VWSession.getQueue を使用して、指定されたキュー名の VWQueue オブジェクトを取得します。
getQueueNames()
VWSession セッション・オブジェクト・フラグを使用して、(VWSession.fetchQueueNames によって) 返されるキュー名をフィルター処理します。