nablarch.common.code

インタフェース CodeManager

@Published(tag="architect")
public interface CodeManager

コードの値と名称を取り扱うインタフェース。

作成者:

Koichi Asano

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	contains(String codeId, String value) コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
boolean	contains(String codeId, String pattern, String value) コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
String	getName(String codeId, String value) コードID、コード値を条件に、対応するコード名称を取得する。
String	getName(String codeId, String value, Locale locale) コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。
String	getOptionalName(String codeId, String value, String optionColumnName) コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
String	getOptionalName(String codeId, String value, String optionColumnName, Locale locale) コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
String	getShortName(String codeId, String value) コードID、コード値を条件に、対応するコードの略称を取得する。
String	getShortName(String codeId, String value, Locale locale) コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。
List	getValues(String codeId) コードIDに紐付く全てのコード値を取得する。
List	getValues(String codeId, Locale locale) コードIDと言語を条件に、対応するコード値を全て取得する。
List	getValues(String codeId, String pattern) コードID、パターンを条件に、対応するコード値を全て取得する。
List	getValues(String codeId, String pattern, Locale locale) コードID、パターン、言語を条件に、対応するコード値を全て取得する。

メソッドの詳細

getName

String getName(String codeId,
               String value)

コードID、コード値を条件に、対応するコード名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

パラメータ:

codeId - コードID

value - コード値

戻り値:

対応するコード名称

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 対象のコード値または言語に対応するデータが存在しない場合

getName

String getName(String codeId,
               String value,
               Locale locale)

コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。

パラメータ:

codeId - コードID

value - コード値

locale - 取得対象の言語

戻り値:

対応するコード名称

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 対象のコード値または言語に対応するデータが存在しない場合

getShortName

String getShortName(String codeId,
                    String value)

コードID、コード値を条件に、対応するコードの略称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

パラメータ:

codeId - コードID

value - コード値

戻り値:

対応するコードの略称

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 対象のコード値または言語に対応するデータが存在しない場合

getShortName

String getShortName(String codeId,
                    String value,
                    Locale locale)

コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。

パラメータ:

codeId - コードID

value - コード値

locale - 取得対象の言語

戻り値:

対応するコードの略称

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 対象のコード値または言語に対応するデータが存在しない場合

getOptionalName

String getOptionalName(String codeId,
                       String value,
                       String optionColumnName)

コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

パラメータ:

codeId - コードID

value - コード値

optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）

戻り値:

対応するオプション名称

例外:

IllegalArgumentException - 指定したコードIDが存在しない場合、 指定したオプション名称のカラムが存在しない場合、 対象のコード値または言語に対応するデータが存在しない場合

getOptionalName

String getOptionalName(String codeId,
                       String value,
                       String optionColumnName,
                       Locale locale)

コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

パラメータ:

codeId - コードID

value - コード値

optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）

locale - 言語

戻り値:

対応するコードのオプション名称

例外:

IllegalArgumentException - 指定したコードIDが存在しない場合、 指定したオプション名称のカラムが存在しない場合、 対象のコード値または言語に対応するデータが存在しない場合

getValues

List getValues(String codeId)

コードIDに紐付く全てのコード値を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

パラメータ:

codeId - コードID

戻り値:

コードIDに紐付く全てのコード値

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 対象のコード値または言語に対応するデータが存在しない場合

getValues

List getValues(String codeId,
               String pattern)

コードID、パターンを条件に、対応するコード値を全て取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。 返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

戻り値:

コードIDとパターンに紐付くコード値

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 パターンまたは言語に対応するデータが存在しない場合

getValues

List getValues(String codeId,
               Locale locale)

コードIDと言語を条件に、対応するコード値を全て取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

パラメータ:

codeId - コードID

locale - 言語

戻り値:

コードIDに紐付く全てのコード値

例外:

IllegalArgumentException - 対応するコードが存在しなかった場合。

getValues

List getValues(String codeId,
               String pattern,
               Locale locale)

コードID、パターン、言語を条件に、対応するコード値を全て取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

locale - 言語

戻り値:

コードIDとパターンに紐付くコード値

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 パターンまたは言語に対応するデータが存在しない場合

contains

boolean contains(String codeId,
                 String value)

コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
コードIDが存在する上で、そのコード値に対応するコードが存在する場合はtrueを、 存在しない場合はfalseを返却する。

パラメータ:

codeId - コードID

value - コード値

戻り値:

コード値がコードに存在する場合 true

例外:

IllegalArgumentException - コードIDが存在しなかった場合。

contains

boolean contains(String codeId,
                 String pattern,
                 String value)

コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
コードID、パターンが存在する上で、 そのコード値に対応するコードがパターン内に存在する場合にはtrueを、存在しない場合にはfalseを返却する。

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

value - コード値

戻り値:

コード値がコードに存在する場合 true

例外:

IllegalArgumentException - 指定したコードIDが存在しないか、 指定したパターンが存在しない場合