6.2.4 deleteメソッド
中断再開プラグインで，中断情報を削除するメソッドです。パラメタに指定された業務コンテンツIDに関連づいた中断情報を削除します。
このメソッドがUCNPPluginException例外をスローした場合，ナビゲーション プラットフォームはUCNPPluginException例外のメッセージをダイアログに表示します。ダイアログに表示するメッセージにはメッセージIDは付きません。
このメソッドの処理は，ひな形プラグイン作成コマンドで作成した中断再開アクションコントローラクラスに実装します。
- 〈この項の構成〉
(1) 形式
public void delete(String contentId, HttpSession session)
throws UCNPPluginException;
(2) 引数
(a) contentId
業務コンテンツIDが表示されます。
(b) session
現在のセッションが格納されます。プラグインの中で取得した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) 呼び出しタイミング
ナビゲーション プラットフォームがこのメソッドを呼び出すタイミングを次に示します。
-
利用者が，業務実行画面で［完了］ボタンをクリックしたとき
-
中断再開アクションコントローラインタフェースを継承した実装クラスのloadメソッドが呼び出されたあと，そのloadメソッドが返した中断情報のチェックでエラーが発生したとき
loadメソッドが返した中断情報のチェックでは，中断情報を保存した時点から業務コンテンツが更新されているかどうかをチェックし，更新されている場合にエラーとなります。loadメソッドが呼び出されるタイミングについては，「6.2 ISuspendActionController（中断再開アクションコントローラインタフェース）」のloadメソッドの説明を参照してください。
- 注意事項
-
この機能は，中断再開プラグインがシステムで有効な場合だけ呼び出されます。中断再開プラグインがシステムで無効な場合は，上記のタイミングでも呼び出されません。