6.2.3 containsメソッド
中断再開プラグインで,中断情報の存在を確認するメソッドです。パラメタに指定された業務コンテンツIDに関連づいた中断情報があるかどうかを確認します。関連した中断情報がある場合はtrue,ない場合はfalseを返します。
このメソッドがUCNPPluginException例外をスローした場合,ナビゲーション プラットフォームはUCNPPluginException例外のメッセージをダイアログに表示します。ダイアログに表示するメッセージにはメッセージIDは付きません。
このメソッドの処理は,ひな形プラグイン作成コマンドで作成した中断再開アクションコントローラクラスに実装します。
- 〈この項の構成〉
(1) 形式
public boolean contains(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) 戻り値
-
true:業務コンテンツIDに関連づいた中断情報がある
-
false:業務コンテンツIDに関連づいた中断情報がない
(4) 例外
UCNPPluginException - 中断情報の読み込み処理などでエラーが発生した場合
ナビゲーション プラットフォームは,このメソッドがスローしたUCNPPluginException例外の詳細メッセージを,業務実行画面のダイアログに表示します。スローするUCNPPluginException例外には,どのようなエラーが起こったか,またどのように対処すればよいかが,利用者にわかるメッセージを設定してください。中断再開プラグインが出力するエラーメッセージに,多数の改行を含む場合,メッセージダイアログの一部が,画面に表示されなくなる場合があります。これは,JavaScriptのAlertでエラーメッセージを表示するためです。エラーメッセージは画面に表示できる長さにしてください。
(5) 呼び出しタイミング
ナビゲーション プラットフォームが,このメソッドを呼び出すタイミングを次に示します。
-
ユーザが業務実行画面で業務コンテンツを選択したとき
-
URLを直接指定し,業務コンテンツIDを指定するパラメタ(contentId)で,業務コンテンツが選択されたとき