jp.co.intra_mart.foundation.ui.page

クラス Transfer

java.lang.Object

jp.co.intra_mart.foundation.ui.page.Transfer

public final class Transfer
extends Object

メッセージ表示画面へ遷移するメソッドを提供します。 メッセージ表示画面に表示できるのは、

• タイトル
• メッセージ
• 詳細なエラーメッセージ

の3つです。

また、メッセージ表示画面を表示した後の遷移先を指定することもできます。
遷移先URL、遷移先URLのラベルを指定すると、画面遷移のボタンが表示されます。
遷移先URLへ引き渡すパラメータを指定すると、そのパラメータが遷移先に引き渡されます。
メッセージ表示画面へはリダイレクト ( HttpServletResponse#sendRedirect ) を利用して遷移します。

バージョン:

8.0

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Transfer.Message メッセージ表示画面へ表示する値のモデルクラスです。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static String	ready(String type, Transfer.Message param) 指定されたパラメータ、タイプに従って、メッセージ表示画面へ遷移するための準備を行います。
static void	toErrorPage(Transfer.Message param) エラー画面へ遷移します。
static void	toInformationPage(Transfer.Message param) インフォメーション画面へ遷移します。
static void	toWarningPage(Transfer.Message param) 警告画面へ遷移します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

ready

public static String ready(String type,
                           Transfer.Message param)
                    throws IOException

指定されたパラメータ、タイプに従って、メッセージ表示画面へ遷移するための準備を行います。 このメソッドはシステム内部で使うためのものです。通常は toErrorPage(), toWarningPage(), toInformationPage() を使用してください。

パラメータ:

type - タイプ

param - パラメータ

戻り値:

遷移先URL

例外:

IOException - 遷移先URLへ送信するキーの生成に失敗した

toErrorPage

public static void toErrorPage(Transfer.Message param)
                        throws IOException

エラー画面へ遷移します。
指定するパラメータの詳細はMessageを参照してください。

title

エラー画面のタイトルを指定します。ブラウザのタイトルバー、画面のタイトルバーの両方に同じタイトルが表示されます。

message

主となるメッセージを指定します。

detail

補助的なメッセージを指定します。String、Array を指定することができます。Array を指定すると、Array の内容が複数行にわたって表示されます。

returnUrl

遷移先URLを指定します。

returnUrlLabel

遷移先URLへ遷移するボタンのラベルを指定します。

parameter

遷移先URLへ送信するパラメータを指定します。

status

遷移先の画面がクライアントへ返すHTTPのレスポンスコードを指定します。指定しない場合、500が遷移先の画面へ渡されます。

使用例：

 Message message = new Message();
 message.setTitle("タイトル");
 message.setMessage("メッセージ");
 String[] details = {"詳細メッセージ1", "詳細メッセージ2"};
 message.setDetails(details);
 message.setReturnUrl("/login"); // 戻り先URL
 message.setReturnUrlLabel("ログイン画面へ戻る");
  
 // 戻り先 URL へ送信するパラメータ
 Map param = new HashMap();
 List list = new ArrayList();
 list.add("1");
 list.add("2");
 list.add("3");
 param.put("key", "value");
 param.put("list", list);
 message.setParameters(param);
  
 Transfer.toErrorPage(message);
 

パラメータ:

Message - パラメータ

例外:

IOException - 画面遷移に失敗した

toInformationPage

public static void toInformationPage(Transfer.Message param)
                              throws IOException

インフォメーション画面へ遷移します。
指定するパラメータの詳細はMessageを参照してください。

title

インフォメーション画面のタイトルを指定します。ブラウザのタイトルバー、画面のタイトルバーの両方に同じタイトルが表示されます。

message

主となるメッセージを指定します。

detail

補助的なメッセージを指定します。String、Array を指定することができます。Array を指定すると、Array の内容が複数行にわたって表示されます。

returnUrl

遷移先URLを指定します。

returnUrlLabel

遷移先URLへ遷移するボタンのラベルを指定します。

parameter

遷移先URLへ送信するパラメータを指定します。

status

遷移先の画面がクライアントへ返すHTTPのレスポンスコードを指定します。指定しない場合、200が遷移先の画面へ渡されます。

使用例：

 Message message = new Message();
 message.setTitle("タイトル");
 message.setMessage("メッセージ");
 String[] details = {"詳細メッセージ1", "詳細メッセージ2"};
 message.setDetails(details);
 message.setReturnUrl("/login"); // 戻り先URL
 message.setReturnUrlLabel("ログイン画面へ戻る");
  
 // 戻り先 URL へ送信するパラメータ
 Map param = new HashMap();
 List list = new ArrayList();
 list.add("1");
 list.add("2");
 list.add("3");
 param.put("key", "value");
 param.put("list", list);
 message.setParameters(param);
  
 Transfer.toInformationPage(message);
 

パラメータ:

Message - パラメータ

例外:

IOException - 画面遷移に失敗した

toWarningPage

public static void toWarningPage(Transfer.Message param)
                          throws IOException

警告画面へ遷移します。
指定するパラメータの詳細はMessageを参照してください。

title

警告画面のタイトルを指定します。ブラウザのタイトルバー、画面のタイトルバーの両方に同じタイトルが表示されます。

message

主となるメッセージを指定します。

detail

補助的なメッセージを指定します。String、Array を指定することができます。Array を指定すると、Array の内容が複数行にわたって表示されます。

returnUrl

遷移先URLを指定します。

returnUrlLabel

遷移先URLへ遷移するボタンのラベルを指定します。

parameter

遷移先URLへ送信するパラメータを指定します。

status

遷移先の画面がクライアントへ返すHTTPのレスポンスコードを指定します。指定しない場合、200が遷移先の画面へ渡されます。

使用例：

 Message message = new Message();
 message.setTitle("タイトル");
 message.setMessage("メッセージ");
 String[] details = {"詳細メッセージ1", "詳細メッセージ2"};
 message.setDetails(details);
 message.setReturnUrl("/login"); // 戻り先URL
 message.setReturnUrlLabel("ログイン画面へ戻る");
  
 // 戻り先 URL へ送信するパラメータ
 Map param = new HashMap();
 List list = new ArrayList();
 list.add("1");
 list.add("2");
 list.add("3");
 param.put("key", "value");
 param.put("list", list);
 message.setParameters(param);
  
 Transfer.toWarningPage(message);
 

パラメータ:

Message - パラメータ

例外:

IOException - 画面遷移に失敗した