nablarch.common.code

Interface Code

public interface Code

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

Method Summary

Modifier and Type	Method and Description
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) パターンを指定してコード値を取得する。

Method Detail

getCodeId

java.lang.String getCodeId()

コードIDを取得する。

Returns:

コードID

contains

boolean contains(java.lang.String value)

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

Parameters:

value - コード値

Returns:

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

contains

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

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

Parameters:

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

value - コード値

Returns:

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

Throws:

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

getValues

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

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

Parameters:

locale - 言語

Returns:

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

Throws:

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

getValues

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

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

Parameters:

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

locale - 言語

Returns:

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

Throws:

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

getName

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

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

Parameters:

value - コード値

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

Returns:

言語に対応する名称

Throws:

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

getShortName

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

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

Parameters:

value - コード値

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

Returns:

言語に対応する略称

Throws:

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

getOptionalName

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

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

Parameters:

value - コード値

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

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

Returns:

言語に対応する名称

Throws:

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