Package nablarch.common.code

Interface Code

public interface Code
単一のコードデータ(コードIDに紐づくデータ)にアクセスするインタフェース。
Author:
Koichi Asano

  • Method Details

    • getCodeId

      String getCodeId()
      コードIDを取得する。
      Returns:
      コードID

    • contains

      boolean contains(String value)
      コードにコード値が含まれるかチェックする。
      Parameters:
      value - コード値
      Returns:
      コードにコード値が含まれる場合true

    • contains

      boolean contains(String pattern, String value) throws IllegalArgumentException
      パターンにコード値が含まれるかチェックする。
      Parameters:
      pattern - 使用するパターンのカラム名
      value - コード値
      Returns:
      パターンにコード値が含まれる場合true
      Throws:
      IllegalArgumentException - パターンが存在しなかった場合。

    • getValues

      List<String> getValues(Locale locale) throws IllegalArgumentException
      コード値を全て取得する。
      Parameters:
      locale - 言語
      Returns:
      コードに含まれる全てのコード値のリスト
      Throws:
      IllegalArgumentException - 言語に対応するデータが存在しなかった場合。

    • getValues

      List<String> getValues(String pattern, Locale locale) throws IllegalArgumentException
      パターンを指定してコード値を取得する。
      Parameters:
      pattern - 使用するパターンのカラム名
      locale - 言語
      Returns:
      パターンに含まれるコード値のリスト
      Throws:
      IllegalArgumentException - パターンまたは言語に対応するデータが存在しなかった場合。

    • getName

      String getName(String value, Locale locale) throws IllegalArgumentException
      言語を指定してコード名称を取得する。
      Parameters:
      value - コード値
      locale - 取得するコード名称の言語
      Returns:
      言語に対応する名称
      Throws:
      IllegalArgumentException - コード値または言語に対応するデータが存在しなかった場合。

    • getShortName

      String getShortName(String value, Locale locale) throws IllegalArgumentException
      言語を指定してコードの略称を取得する。
      Parameters:
      value - コード値
      locale - 取得するコード名称の言語
      Returns:
      言語に対応する略称
      Throws:
      IllegalArgumentException - コード値または言語に対応するデータが存在しなかった場合。

    • getOptionalName

      String getOptionalName(String value, String optionColumnName, Locale locale) throws IllegalArgumentException
      言語を指定してオプションコード名称を取得する。
      Parameters:
      value - コード値
      optionColumnName - オプション名称のカラム名
      locale - 取得するコード名称の言語
      Returns:
      言語に対応する名称
      Throws:
      IllegalArgumentException - コード値、オプション名称のカラム名、または言語に対応するデータが存在しなかった場合。