パッケージ org.opengion.hayabusa.resource

# インタフェース LabelInterface

既知の実装クラスのリスト:
  `LabelData`

public interface LabelInterface
systemId , lang に対応したラベルデータを作成します。 ラベルデータは、項目(CLM)に対して、各種ラベル情報を持っています。 ラベルデータは、名前(短)と名前(長)を持っています。従来のラベルは、表示名称と して、一種類しか持っていませんでした。 名前(長)は、従来の表示名称にあたります。これは、一般的なラベルとして 使用されます。名前(短)は、テーブル一覧のヘッダーの様に、特殊なケースで、 簡略化された名称を使用するときに利用されます。この切り替えは、自動で判断されます。 名前(短)に、なにも設定されていない場合は、名前(長)が自動的に使用されますので 初期データ移行時には、そのまま、通常時もテーブルヘッダー時も同じ文字列が 使用されます。 ラベルデータを作成する場合は、同一ラベルで、作成区分(KBSAKU)違いの場合は、 最も大きな作成区分を持つコードを使用します。 作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定 という具合に カスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正 することが可能になります。(削除することは出来ません。)

変更履歴:
  4.0.0.0 (2004/12/31) 新規作成
機能分類
  リソース管理
導入されたバージョン:
  JDK5.0,

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `String`
  `getDescription()`
  ラベルインターフェースの概要説明を返します。
  `String`
  `getDescription(String... vals)`
  ラベルインターフェースの引数付きメッセージを返します。
  `String`
  `getKey()`
  ラベルインターフェースのキーを返します。
  `String`
  `getLabel()`
  ラベルインターフェースの名前を返します。
  `String`
  `getLongLabel()`
  ラベルインターフェースの名前(長)を返します。
  `String`
  `getLongLabel(String title)`
  ラベルインターフェースの名前(長)を返します。
  `String`
  `getMessage(String... vals)`
  ラベルインターフェースの引数付きメッセージを返します。
  `String`
  `getShortLabel()`
  ラベルインターフェースの名前(短)を返します。
  `String`
  `getShortMessage(String... vals)`
  ラベルオブジェクトの名称(未変換短)を返します。
  `boolean`
  `isOfficial()`
  リソースＤＢから作成されたかどうかを返します。

- ## メソッドの詳細

  - ### getKey

    String getKey()
    ラベルインターフェースのキーを返します。
    戻り値:
      ラベルインターフェースのキー

  - ### getLabel

    String getLabel()
    ラベルインターフェースの名前を返します。 これは、ＤＢ上の LNAME(名前(長))に該当します。
    戻り値:
      ラベルインターフェースの名前(短)

  - ### getMessage

    String getMessage(String... vals)
    ラベルインターフェースの引数付きメッセージを返します。 メッセージの引数部分に、文字列配列を適用して、MessageFormat で変換した結果を返します。(MessageData でのみ有効です。)
    パラメータ:
      `vals` - メッセージ引数の文字列配列(可変長引数)
    戻り値:
      ラベルインターフェースの引数付きメッセージ

  - ### getShortLabel

    String getShortLabel()
    ラベルインターフェースの名前(短)を返します。 概要説明がない場合でかつＤＢ上のSNAMEが未設定の場合は、 LNAME が返されます。SNAMEが設定されている場合は、 ツールチップにLNAME が表示されます。 概要説明が存在する場合は、ツールチップに概要説明が 表示されます。
    戻り値:
      ラベルインターフェースの名前(短)

  - ### getShortMessage

    String getShortMessage(String... vals)
    ラベルオブジェクトの名称(未変換短)を返します。 このメソッドでは{0},{1}...をパラメータで置換します。
    パラメータ:
      `vals` - メッセージ引数の文字列配列(可変長引数)
    戻り値:
      ラベルインターフェースの名前(短)
    変更履歴:
      7.1.0.1 (2020/02/07) ショートラベルに引数を渡します。

  - ### getLongLabel

    String getLongLabel()
    ラベルインターフェースの名前(長)を返します。 概要説明が存在する場合は、ツールチップに概要説明が 表示されます。
    戻り値:
      ラベルインターフェースの名前(長)
    関連項目:
      - `getLongLabel(String)`

  - ### getLongLabel

    String getLongLabel(String title)
    ラベルインターフェースの名前(長)を返します。 ツールチップに表示するタイトル属性(概要説明)を置き換えます。 null の場合は、既存のgetLongLabel()を返します。
    パラメータ:
      `title` - ツールチップに表示するタイトル属性
    戻り値:
      ラベルインターフェースの名前(長)
    関連項目:
      - `getLongLabel()`

  - ### getDescription

    String getDescription()
    ラベルインターフェースの概要説明を返します。 概要説明が存在する場合は、ラベルのツールチップに 概要説明が表示されます。
    戻り値:
      ラベルインターフェースの概要説明

  - ### getDescription

    String getDescription(String... vals)
    ラベルインターフェースの引数付きメッセージを返します。 概要(対応方法)の引数部分に、文字列配列を適用して、MessageFormat で変換した結果を返します。(MessageData でのみ有効です。)
    パラメータ:
      `vals` - パラメータ配列(可変長引数)
    戻り値:
      ラベルインターフェースの引数付き概要
    変更履歴:
      4.3.7.6 (2009/07/15) 新規作成

  - ### isOfficial

    boolean isOfficial()
    リソースＤＢから作成されたかどうかを返します。 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。
    戻り値:
      リソースＤＢから作成されたかどうか