クラス ErrorMessageTag

  • すべての実装されたインタフェース:
    java.io.Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

    public class ErrorMessageTag
    extends CommonTagSupport
    エラーメッセージを 表形式で表示するタグです。 Query 関係の実行時にエラー/ワーニングが発生すると、HybsSystem.ERR_MSG_KEY をキーに ErrorMessage オブジェクト をセッションに登録します。 この情報を元に、表題(TITLE)か、内容(BODY)を表示します。 基本的には,表題表示時には,リンクを張り、共通エラー表示画面をオープン 出来る様になっています。
    関連項目:
    直列化された形式
    機能分類
    エラー処理
    形式サンプル:
    ●形式: <og:errorMessage command="{@command}" clear="{@clear}" /> ●body:なし ●Tag定義: <og:errorMessage command 【TAG】コマンド (NEW,RENEW,RESET,REVIEW)をセットします clear 【TAG】メッセージを初期化するかどうか[true/false]を指定します(初期値:false) viewType 【TAG】表示形式『表題(TITLE)か、内容(BODY)』を指定します(初期値:TITLE) displayMsg 【TAG】plsqlUpdate の結果を画面上に表示するメッセージIDを指定します(初期値:MSG0059『登録しました』) warningMsg 【TAG】登録処理実行後のワーニング結果を画面上に表示するメッセージIDを指定します(初期値:ERR0020) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 result.jsp 等のSQL登録実行後の戻り画面に、上記タグを配置すれば、 エラーメッセージが存在すれば,リンクとなって現れ、無ければ,なにも 現れません。 リンクのとび先は自動的に設定されます。 なお、clear="true" または、command="NEW" の場合に、エラーメッセージは、 クリアされます。 [entry.jsp] <% String forwardPage="result.jsp"; %> <jsp:forward page="<%= response.encodeRedirectURL( forwardPage ) %>" > <jsp:param name="command" value="REVIEW" /> <jsp:param name="clear" value="false" /> </jsp:forward> [result.jsp] <og:errorMessage command="{@command}" clear="{@clear}" />
    バージョン
    4.0
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK5.0,
    • フィールドの詳細

      • CMD_NEW

        public static final java.lang.String CMD_NEW
        command 引数に渡す事の出来る コマンド 新規 "NEW"
        関連項目:
        定数フィールド値
      • CMD_RENEW

        public static final java.lang.String CMD_RENEW
        command 引数に渡す事の出来る コマンド 再検索 "RENEW"
        関連項目:
        定数フィールド値
      • CMD_RESET

        public static final java.lang.String CMD_RESET
        command 引数に渡す事の出来る コマンド 取消 "RESET"
        関連項目:
        定数フィールド値
      • CMD_REVIEW

        public static final java.lang.String CMD_REVIEW
        command 引数に渡す事の出来る コマンド 再表示 "REVIEW"
        関連項目:
        定数フィールド値
    • コンストラクタの詳細

      • ErrorMessageTag

        public ErrorMessageTag()
        デフォルトコンストラクター
        変更履歴:
        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    • メソッドの詳細

      • doStartTag

        public int doStartTag()
        Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
        定義:
        doStartTag インタフェース内 Tag
        オーバーライド:
        doStartTag クラス内 CommonTagSupport
        戻り値:
        後続処理の指示(SKIP_BODY)
        変更履歴:
        3.5.4.0 (2003/11/25) エラーオブジェクトのクリアに、RENEW or null も追加します。
      • doEndTag

        public int doEndTag()
        Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
        定義:
        doEndTag インタフェース内 Tag
        オーバーライド:
        doEndTag クラス内 CommonTagSupport
        戻り値:
        後続処理の指示
        変更履歴:
        2.1.0.3 (2002/11/08) command = NEW のときも、『登録しました。』メッセージが表示されるバグを修正, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.5.5.2 (2004/04/02) TaglibUtil.makeHTMLErrorTable メソッドを利用, 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel ), 4.1.3.0 (2008/09/04) メッセージをspanで囲う(画面遷移なしモード対応), 5.2.1.0 (2010/10/01) 戻るリンク時に不要な改行が出力される件に対応, 6.4.4.1 (2016/03/18) application オブジェクトに関連付ける 共通メッセージがあれば、表示します。
      • release2

        protected void release2()
        タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
        オーバーライド:
        release2 クラス内 CommonTagSupport
        変更履歴:
        2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 2.0.1.0 (2002/10/10) デフォルト表示しないから、MSG0059=登録しました。に変更します。, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
      • setCommand

        public void setCommand​(java.lang.String cmd)
        【TAG】コマンド (NEW,RENEW,RESET,REVIEW)をセットします。
        パラメータ:
        cmd - コマンド (public static final 宣言されている文字列)
        関連項目:
        コマンド定数
        説明:
        コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される フィールド定数値のいづれかを、指定できます。
      • setClear

        public void setClear​(java.lang.String flag)
        【TAG】メッセージを初期化するかどうか[true/false]を指定します(初期値:false)。
        パラメータ:
        flag - 初期化 [true:クリアする/それ以外:しない]
        説明:
        メッセージは、一般には,エラーメッセージかワーニングです。 最終処理でメッセージが無ければ,標準でクリアします。 また、command が NEW の場合も、メッセージは自動でクリアされます。 初期値は、クリアしない (true 以外)です。
      • setViewType

        public void setViewType​(java.lang.String type)
        【TAG】表示形式『表題(TITLE)か、内容(BODY)』を指定します(初期値:TITLE)。
        パラメータ:
        type - 表示形式 [TITLE:表題/BODY:内容]
        説明:
        一般には,表題(TITLE) を表示しておきます。 表題表示時には,リンクを張り、共通エラー表示画面をオープン 出来る様になっています。
      • setDisplayMsg

        public void setDisplayMsg​(java.lang.String id)
        【TAG】plsqlUpdate の結果を画面上に表示するメッセージIDを指定します(初期値:MSG0059『登録しました』)。
        パラメータ:
        id - 処理結果表示メッセージID
        説明:
        指定したメッセージをリソースから取得して表示します。 表示させたくない場合は, displayMsg = "MSG0065" をセットしてください。 初期値は、MSG0059『登録しました。』を表示します。
        変更履歴:
        2.0.1.0 (2002/10/10) デフォルト表示しないから、MSG0059=登録しました。に変更します。, 3.2.0.0 (2003/05/22) 引数に何もセットされないときに、デフォルトの文字を表示するように変更。
      • setWarningMsg

        public void setWarningMsg​(java.lang.String id)
        【TAG】登録処理実行後のワーニング結果を画面上に表示するメッセージIDを指定します(初期値:ERR0020)。
        パラメータ:
        id - 警告時メッセージID
        説明:
        指定したメッセージをリソースから取得して表示します。 表示させたくない場合は, warningMsg = "" をセットしてください。 初期値は、ERR0020『データ登録時にワーニングが発生しました。』を表示します。
        変更履歴:
        2.0.1.0 (2002/10/10) デフォルト表示しないから、ERR0020=データ登録時にワーニングが発生しました。に変更します。
      • toString

        public java.lang.String toString()
        デバッグ時の文字列を返します。
        オーバーライド:
        toString クラス内 CommonTagSupport
        戻り値:
        このオブジェクトのデバッグ表現文字列
        このメソッドは、nullを返しません