nablarch.common.code

インタフェース Code

public interface Code

単一のコードデータ(コードIDに紐づくデータ)にアクセスするインタフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	contains(java.lang.String value) コードにコード値が含まれるかチェックする。
boolean	contains(java.lang.String pattern, java.lang.String value) パターンにコード値が含まれるかチェックする。
java.lang.String	getCodeId() コードIDを取得する。
java.lang.String	getName(java.lang.String value, java.util.Locale locale) 言語を指定してコード名称を取得する。
java.lang.String	getOptionalName(java.lang.String value, java.lang.String optionColumnName, java.util.Locale locale) 言語を指定してオプションコード名称を取得する。
java.lang.String	getShortName(java.lang.String value, java.util.Locale locale) 言語を指定してコードの略称を取得する。
java.util.List<java.lang.String>	getValues(java.util.Locale locale) コード値を全て取得する。
java.util.List<java.lang.String>	getValues(java.lang.String pattern, java.util.Locale locale) パターンを指定してコード値を取得する。

メソッドの詳細

getCodeId

java.lang.String getCodeId()

コードIDを取得する。

戻り値:

コードID

contains

boolean contains(java.lang.String value)

コードにコード値が含まれるかチェックする。

パラメータ:

value - コード値

戻り値:

コードにコード値が含まれる場合true

contains

boolean contains(java.lang.String pattern,
                 java.lang.String value)
          throws java.lang.IllegalArgumentException

パターンにコード値が含まれるかチェックする。

パラメータ:

pattern - 使用するパターンのカラム名

value - コード値

戻り値:

パターンにコード値が含まれる場合true

例外:

java.lang.IllegalArgumentException - パターンが存在しなかった場合。

getValues

java.util.List<java.lang.String> getValues(java.util.Locale locale)
                                    throws java.lang.IllegalArgumentException

コード値を全て取得する。

パラメータ:

locale - 言語

戻り値:

コードに含まれる全てのコード値のリスト

例外:

java.lang.IllegalArgumentException - 言語に対応するデータが存在しなかった場合。

getValues

java.util.List<java.lang.String> getValues(java.lang.String pattern,
                                           java.util.Locale locale)
                                    throws java.lang.IllegalArgumentException

パターンを指定してコード値を取得する。

パラメータ:

pattern - 使用するパターンのカラム名

locale - 言語

戻り値:

パターンに含まれるコード値のリスト

例外:

java.lang.IllegalArgumentException - パターンまたは言語に対応するデータが存在しなかった場合。

getName

java.lang.String getName(java.lang.String value,
                         java.util.Locale locale)
                  throws java.lang.IllegalArgumentException

言語を指定してコード名称を取得する。

パラメータ:

value - コード値

locale - 取得するコード名称の言語

戻り値:

言語に対応する名称

例外:

java.lang.IllegalArgumentException - コード値または言語に対応するデータが存在しなかった場合。

getShortName

java.lang.String getShortName(java.lang.String value,
                              java.util.Locale locale)
                       throws java.lang.IllegalArgumentException

言語を指定してコードの略称を取得する。

パラメータ:

value - コード値

locale - 取得するコード名称の言語

戻り値:

言語に対応する略称

例外:

java.lang.IllegalArgumentException - コード値または言語に対応するデータが存在しなかった場合。

getOptionalName

java.lang.String getOptionalName(java.lang.String value,
                                 java.lang.String optionColumnName,
                                 java.util.Locale locale)
                          throws java.lang.IllegalArgumentException

言語を指定してオプションコード名称を取得する。

パラメータ:

value - コード値

optionColumnName - オプション名称のカラム名

locale - 取得するコード名称の言語

戻り値:

言語に対応する名称

例外:

java.lang.IllegalArgumentException - コード値、オプション名称のカラム名、または言語に対応するデータが存在しなかった場合。