Cosminexus V9 ナビゲーション プラットフォーム 開発ガイド

[目次][用語][索引][前へ][次へ]

5.5.5 deleteAllメソッド

中断再開プラグインで,業務コンテンツに関連づいたすべての中断情報を削除するメソッドです。パラメタに指定された業務コンテンツIDに関連づいたすべての中断情報を削除します。

業務コンテンツを作成するユーザが業務コンテンツを編集または削除した場合に,関連づいた中断情報をすべて削除するためにこのメソッドを呼び出します。業務コンテンツが編集または削除されると,すでに保存されている中断情報は無効になるため,関連するすべての中断情報を削除してください。

このメソッドがUCNPPluginException例外をスローした場合,ナビゲーション プラットフォームはUCNPPluginException例外のメッセージをダイアログに表示します。ダイアログに表示するメッセージにはメッセージIDは付きません。

このメソッドの処理は,ひな形プラグイン作成コマンドで作成した中断再開アクションコントローラクラスに実装します。

<この項の構成>
(1) 形式
(2) 引数
(3) 戻り値
(4) 例外
(5) 呼び出しタイミング

(1) 形式

public void deleteAll(String contentId, HttpSession session)
                                      throws UCNPPluginException;

(2) 引数

(a) contentId

業務コンテンツIDが表示されます。

(b) session

現在のセッションが格納されます。このセッションに対してsetAttribute()メソッドを実行する場合,setAttribute()メソッドの引数nameに次の名前を指定しないでください。

また,URLのリクエストパラメタを取得して利用することもできます。URLのリクエストパラメタを利用する場合は,次のキーでucnpOptionsパラメタを取得する必要があります。

ucnp.request.optionsキー
セッションから,URLに指定したucnpOptionsパラメタの値を取得するためのキーです。HttpSession.getAttribute()メソッドにこのキーを指定することで,URLデコードされたucnpOptionsパラメタの値を取得できます。URLにucnpOptionsパラメタが指定されていない場合は,nullを返します。
ucnp.request.optionsキーの指定例については,「5.3 IIoPluginController(サーバ処理実装インタフェース)」のinputFromNodeメソッドの指定例を参照してください。

(3) 戻り値

なし

(4) 例外

UCNPPluginException - 中断情報の削除処理などでエラーが発生した場合

ナビゲーション プラットフォームは,このメソッドがスローしたUCNPPluginException例外の詳細メッセージを,業務実行画面のダイアログに表示します。スローするUCNPPluginException例外には,どのようなエラーが起こったか,またどのように対処すればよいかが,利用者にわかるメッセージを設定してください。なお,中断再開プラグインが出力するエラーメッセージが多数の改行を含む場合,JavaScriptのAlertでエラーメッセージを表示するので,メッセージダイアログの一部が画面に表示されなくなる場合があります。そのため,エラーメッセージは画面に表示できる長さにしてください。

(5) 呼び出しタイミング

ナビゲーション プラットフォームがこのメソッドを呼び出すタイミングと,削除対象となる中断情報を次に示します。

表5-12 deleteAllメソッドの呼び出しタイミングと削除対象の中断情報

呼び出しタイミング 削除対象の中断情報
業務コンテンツを作成するユーザが,業務編集画面で業務コンテンツを編集して保存したとき 編集した業務コンテンツに関する,すべての中断情報
業務コンテンツを作成するユーザが,業務編集画面で業務コンテンツを削除したとき 削除した業務コンテンツに関する,すべての中断情報
業務コンテンツを作成するユーザが,ドロップダウンの選択項目を一括設定するCSVファイルを更新して,業務コンテンツを更新したとき 選択した業務コンテンツに関する,すべての中断情報
業務コンテンツを作成するユーザが,業務編集画面で業務コンテンツの属性を変更したとき 選択した業務コンテンツに関する,すべての中断情報
プラグインを開発するユーザが,業務編集画面で[プラグインパーツ更新]メニューを選択して,業務コンテンツを更新したとき 更新した業務コンテンツに関する,すべての中断情報