Package nablarch.common.code
Interface Code
public interface Code
単一のコードデータ(コードIDに紐づくデータ)にアクセスするインタフェース。
-
Method Summary
Modifier and TypeMethodDescriptionboolean
コードにコード値が含まれるかチェックする。boolean
パターンにコード値が含まれるかチェックする。コードIDを取得する。言語を指定してコード名称を取得する。getOptionalName
(String value, String optionColumnName, Locale locale) 言語を指定してオプションコード名称を取得する。getShortName
(String value, Locale locale) 言語を指定してコードの略称を取得する。パターンを指定してコード値を取得する。コード値を全て取得する。
-
Method Details
-
getCodeId
String getCodeId()コードIDを取得する。- Returns:
- コードID
-
contains
コードにコード値が含まれるかチェックする。- Parameters:
value
- コード値- Returns:
- コードにコード値が含まれる場合true
-
contains
パターンにコード値が含まれるかチェックする。- Parameters:
pattern
- 使用するパターンのカラム名value
- コード値- Returns:
- パターンにコード値が含まれる場合true
- Throws:
IllegalArgumentException
- パターンが存在しなかった場合。
-
getValues
コード値を全て取得する。- Parameters:
locale
- 言語- Returns:
- コードに含まれる全てのコード値のリスト
- Throws:
IllegalArgumentException
- 言語に対応するデータが存在しなかった場合。
-
getValues
パターンを指定してコード値を取得する。- Parameters:
pattern
- 使用するパターンのカラム名locale
- 言語- Returns:
- パターンに含まれるコード値のリスト
- Throws:
IllegalArgumentException
- パターンまたは言語に対応するデータが存在しなかった場合。
-
getName
言語を指定してコード名称を取得する。- Parameters:
value
- コード値locale
- 取得するコード名称の言語- Returns:
- 言語に対応する名称
- Throws:
IllegalArgumentException
- コード値または言語に対応するデータが存在しなかった場合。
-
getShortName
言語を指定してコードの略称を取得する。- Parameters:
value
- コード値locale
- 取得するコード名称の言語- Returns:
- 言語に対応する略称
- Throws:
IllegalArgumentException
- コード値または言語に対応するデータが存在しなかった場合。
-
getOptionalName
String getOptionalName(String value, String optionColumnName, Locale locale) throws IllegalArgumentException 言語を指定してオプションコード名称を取得する。- Parameters:
value
- コード値optionColumnName
- オプション名称のカラム名locale
- 取得するコード名称の言語- Returns:
- 言語に対応する名称
- Throws:
IllegalArgumentException
- コード値、オプション名称のカラム名、または言語に対応するデータが存在しなかった場合。
-