6.2.2 loadメソッド
中断再開プラグインで,中断情報を読み込んで復元するメソッドです。パラメタに指定された業務コンテンツIDに関連づいた中断情報を読み込みます。
contains()メソッドの戻り値がtrueの場合だけ,このメソッドは呼び出されます。したがって,このメソッドの戻り値がnullの場合,ダイアログにプラグインエラーのメッセージを表示します。中断情報がない場合は,UCNPPluginException例外にメッセージを設定してスローしてください。
このメソッドがUCNPPluginException例外をスローした場合,ナビゲーション プラットフォームはUCNPPluginException例外のメッセージをダイアログに表示します。ダイアログに表示するメッセージにはメッセージIDは付きません。
このメソッドの戻り値が不正な場合,または,このメソッドがUCNPPluginException例外をスローした場合は,メッセージをダイアログに表示したあと,業務を最初から開始します。
- 〈この項の構成〉
(1) 形式
public ISuspendInfo load(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) 戻り値
業務コンテンツIDに関連づいた中断情報
(4) 例外
UCNPPluginException - 中断情報の読み込み処理などでエラーが発生した場合
ナビゲーション プラットフォームは,このメソッドがスローしたUCNPPluginException例外の詳細メッセージを,業務実行画面のダイアログに表示します。スローするUCNPPluginException例外には,どのようなエラーが起こったか,またどのように対処すればよいかが,利用者にわかるメッセージを設定してください。中断再開プラグインが出力するエラーメッセージに,多数の改行を含む場合,メッセージダイアログの一部が,画面に表示されなくなる場合があります。これは,JavaScriptのAlertでエラーメッセージを表示するためです。エラーメッセージは画面に表示できる長さにしてください。
(5) 呼び出しタイミング
ナビゲーション プラットフォームがこのメソッドを呼び出すタイミングを次に示します。
-
中断再開アクションコントローラインタフェースを継承した実装クラスのcontains()メソッドが呼び出されたあと,そのcontains()メソッドがtrueを返したとき
contains()メソッドがfalseを返したとき,およびUCNPPluginException例外をスローしたときは呼び出されません。contains()メソッドが呼び出されるタイミングについては,「6.2 ISuspendActionController(中断再開アクションコントローラインタフェース)」のcontainsメソッドの説明を参照してください。