pexa.client.std.message

インタフェース MessageManager

すべてのスーパーインタフェース:

ClientManager, Refreshable

既知の実装クラスのリスト:

DefaultMessageManager

public interface MessageManager
extends ClientManager

画面の表示メッセージを管理するクラスが実装すべきインタフェース。
以下の役割を持つ。

• 実行時localeに対応するメッセージ定義からメッセージを取得して返す。
• 実行時localeに対応するエラー定義からエラーメッセージを取得して返す。
• メッセージ中の変数にContentから取得した値を埋め込む
• メッセージ中の変数にエラー情報から取得した値を埋め込む

バージョン:

$Revision: 8074 $ $Date:: 2015-06-18 16:25:50 #$

作成者:

morishita

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	KEY_MessageManager MessageManagerを表すキー

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ErrorMessage	getErrorMessage(java.lang.Throwable error) 引数で与えられたエラー情報に対応するエラーメッセージ情報を取得する。
Message	getMessage(java.lang.String messageListID, java.lang.String messageID) 指定されたIDのメッセージを取得する。
Message	getMessage(java.lang.String messageListID, java.lang.String messageID, Content valueSource) 指定されたIDのメッセージを取得する。
java.util.Set<java.lang.String>	getMessageIDList(java.lang.String messageListID) メッセージ一覧のメッセージIDのセットを戻します。

インタフェースから継承されたメソッド pexa.client.std.platform.ClientManager

destroy, getManagerKey

インタフェースから継承されたメソッド pexa.share.util.res.Refreshable

refresh

フィールドの詳細

KEY_MessageManager

static final java.lang.String KEY_MessageManager

MessageManagerを表すキー

関連項目:

定数フィールド値

メソッドの詳細

getErrorMessage

ErrorMessage getErrorMessage(java.lang.Throwable error)
                      throws RecoverableException

引数で与えられたエラー情報に対応するエラーメッセージ情報を取得する。 メッセージの取得元は、このメソッドがコールされた時点の実行時localeに対応するエラー定義となる。 また、メッセージ中に変数が含まれる場合は、変数名に対応する値を引数で渡された エラー情報から取得してメッセージに埋め込む。

パラメータ:

error - エラー情報

戻り値:

エラーメッセージ情報

例外:

RecoverableException - エラーメッセージ生成に失敗

getMessage

Message getMessage(java.lang.String messageListID,
                   java.lang.String messageID)
            throws RecoverableException

指定されたIDのメッセージを取得する。 メッセージの取得元は、このメソッドがコールされた時点の実行時localeに対応するメッセージ定義となる。

パラメータ:

messageListID - メッセージリストID

messageID - メッセージID

戻り値:

実行時localeに対応する表示メッセージ文字列

例外:

RecoverableException - メッセージ生成に失敗

getMessage

Message getMessage(java.lang.String messageListID,
                   java.lang.String messageID,
                   Content valueSource)
            throws RecoverableException

指定されたIDのメッセージを取得する。 メッセージの取得元は、このメソッドがコールされた時点の実行時localeに対応するメッセージ定義となる。 また、メッセージ中に変数が含まれる場合は、変数名に対応するContentItemを 引数で渡されたContentから取得して埋め込む。

パラメータ:

messageListID - メッセージリストID

messageID - メッセージID

valueSource - メッセージ中の変数に与える値を保持するContent。null可(変数変換しない)

戻り値:

変数値を変換した、実行時localeに対応する表示メッセージ文字列

例外:

RecoverableException - メッセージ生成に失敗

getMessageIDList

java.util.Set<java.lang.String> getMessageIDList(java.lang.String messageListID)

メッセージ一覧のメッセージIDのセットを戻します。

パラメータ:

messageListID - メッセージ一覧ID

戻り値:

メッセージIDセット(String)