6.2.5 deleteAllメソッド
中断再開プラグインで，業務コンテンツに関連づいたすべての中断情報を削除するメソッドです。パラメタに指定された業務コンテンツIDに関連づいたすべての中断情報を削除します。
業務コンテンツを作成するユーザが業務コンテンツを編集または削除した場合に，関連づいた中断情報をすべて削除するためにこのメソッドを呼び出します。業務コンテンツが編集または削除されると，すでに保存されている中断情報は無効になるため，関連するすべての中断情報を削除してください。
このメソッドがUCNPPluginException例外をスローした場合，ナビゲーション プラットフォームはUCNPPluginException例外のメッセージをダイアログに表示します。ダイアログに表示するメッセージにはメッセージIDは付きません。
このメソッドの処理は，ひな形プラグイン作成コマンドで作成した中断再開アクションコントローラクラスに実装します。
- 〈この項の構成〉
(1) 形式
public void deleteAll(String contentId, HttpSession session)
throws UCNPPluginException;
(2) 引数
(a) contentId
業務コンテンツIDが表示されます。
(b) session
現在のセッションが格納されます。公開予約状態の業務コンテンツの公開開始処理でこのメソッドが実行された場合，値はnullになります。プラグインの中で取得したHttpSessionオブジェクトに対してsetAttribute()メソッドを実行する場合，setAttribute()メソッドの引数nameに次の名前を指定しないでください。
-
"ucnp"で始まる名前
-
"java."で始まる名前
-
"javax."で始まる名前
-
"javax.portlet."で始まる名前
-
"hptl"で始まる名前
-
"com.cosminexus"で始まる名前
-
"jp.co.hitachi.soft.portal"で始まる名前
また，URLのリクエストパラメタを取得して利用することもできます。URLのリクエストパラメタを利用する場合は，次のキーでucnpOptionsパラメタを取得する必要があります。
- ucnp.request.optionsキー
-
セッションから，URLに指定したucnpOptionsパラメタの値を取得するためのキーです。HttpSession.getAttribute()メソッドにこのキーを指定することで，URLデコードされたucnpOptionsパラメタの値を取得できます。URLにucnpOptionsパラメタが指定されていない場合は，nullを返します。
ucnp.request.optionsキーの指定例については，「5.2 IIoPluginController（サーバ処理実装インタフェース）」のinputFromNodeメソッドの指定例を参照してください。
(3) 戻り値
なし
(4) 例外
UCNPPluginException - 中断情報の削除処理などでエラーが発生した場合
ナビゲーション プラットフォームは，このメソッドがスローしたUCNPPluginException例外の詳細メッセージを，業務実行画面のダイアログに表示します。スローするUCNPPluginException例外には，どのようなエラーが起こったか，またどのように対処すればよいかが，利用者にわかるメッセージを設定してください。中断再開プラグインが出力するエラーメッセージに，多数の改行を含む場合，メッセージダイアログの一部が，画面に表示されなくなる場合があります。これは，JavaScriptのAlertでエラーメッセージを表示するためです。エラーメッセージは画面に表示できる長さにしてください。
(5) 呼び出しタイミング
ナビゲーション プラットフォームがこのメソッドを呼び出すタイミングと，削除対象となる中断情報を次に示します。
|
呼び出しタイミング |
削除対象の中断情報 |
|---|---|
|
Webブラウザ上の操作により，業務実行画面に表示する業務コンテンツの内容が変化したとき |
対象の業務コンテンツに関する，すべての中断情報 |
|
業務コンテンツを作成するユーザが，業務編集画面で業務コンテンツを削除したとき |
削除した業務コンテンツに関する，すべての中断情報 |