タスク処理ヘルパー・クラスは、「新規ポートレット・プロジェクト」ウィザードまたは 「新規ポートレット」ウィザードで「タスク処理の追加 (Add task processing)」オプションを使用可能にしてビジネス・プロセス・ポートレットを作成した場合に生成されます。 クラスは、タスク処理ポートレット・プロジェクトの /WEB-INF/lib にコピーされる JAR ファイル (JSR 168 API の場合は portlet-bp.jar、 IBM® ポートレット API の場合は wp-portlet-bp.jar) に組み込まれます。
ヘルパー・クラスは、タスク処理ポートレットの共通コードをカプセル化します。 選択するポートレット API に応じて、次の 2 つのヘルパー・クラスがあります。
JSR 168 ポートレット API メソッド | IBM ポートレット API メソッド | 説明 |
---|---|---|
public void init() | public void init(PortletConfig config) | このメソッドは、タスク・マネージャーおよびタスク UI マネージャー・サービスを初期化します。 |
public void receivePageContext(ActionRequest request) | public void setProperties(PortletRequest request, PropertyValue[] properties) | このメソッドは、タスク・プロパティー (タスク ID、タスク UI ハンドル、および戻りページ ID) を受け取り、入出力メッセージをセッション属性 (TASK_INPUT_MESSAGE および TASK_OUTPUT_MESSAGE) 内に作成し保管します。 入出力メッセージ用のマップ・インターフェースは、 セッション属性内に保管されるので、メッセージ・パーツの獲得/設定に get() および put() メソッドを使用できます。 JSR 168 API タスク・ポートレットの processAction() メソッドからは receivePageContext() を、IBM ポートレット API タスク・ポートレットの setProperties() メソッドからは setProperties() を呼び出す必要があります。 |
public void processTask() | public void processTask() | このメソッドは、セッション属性内の出力メッセージを使用して、タスクを完了させます。 |
pubic void closePage(ActionRequest request, ActionResponse response) | public void closePage(ActionEvent event) | このメソッドは、タスク・ページを閉じます。これは、通常、 processAction() メソッドで processTask() を呼び出した後に呼び出されます。 |