001 /*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016 package org.opengion.hayabusa.resource;
017
018 /**
019 * systemId , lang に対応したラベル??タを作?します?
020 *
021 * ラベル??タは??目(CLM)に対して、各種ラベル??を持って?す?
022 * ラベル??タは、名?短)と名前(長)を持って?す?従来のラベルは、表示名称と
023 * して、?類しか持って?せんでした?
024 * 名前(長)は、従来の表示名称にあたります?これは、??ラベルとして
025 * 使用されます?名前(短)は、テーブル?のヘッ??の様に、特殊なケースで?
026 * 簡略化された名称を使用するときに利用されます?こ??替え?、?動で判断されます?
027 * 名前(短)に、なにも設定されて???合?、名?長)が?動的に使用されます?で
028 * 初期??タ移行時には、そのまま??常時も??ブルヘッ??時も同じ???
029 * 使用されます?
030 *
031 * ラベル??タを作?する場合?、同?ベルで、作?区?KBSAKU)違いの場合??
032 * ?大きな作?区?持つコードを使用します?
033 * 作?区?KBSAKU)は?:シス?予??1:アプリ設定?2:ユーザー設?と?具合に
034 * カスタマイズの度合いに応じて大きな数字を割り当てることで、キー??を上書き修正
035 * することが可能になります?(削除することは出来ません?
036 *
037 * @og.rev 4.0.0.0 (2004/12/31) 新規作?
038 * @og.group リソース管?
039 *
040 * @version 4.0
041 * @author Kazuhiko Hasegawa
042 * @since JDK5.0,
043 */
044 public interface LabelInterface {
045
046 /**
047 * ラベルインターフェースのキーを返します?
048 *
049 * @return ラベルインターフェースのキー
050 */
051 String getKey() ;
052
053 /**
054 * ラベルインターフェースの名前を返します?
055 * これは??上? LNAME(名前(長))に該当します?
056 *
057 * @return ラベルインターフェースの名前(短)
058 */
059 String getLabel() ;
060
061 /**
062 * ラベルインターフェースの引数付きメ?ージを返します?
063 * メ?ージの引数部?、文字?配?を適用して、MessageFormat
064 * で変換した結果を返します?(MessageData でのみ有効です?)
065 *
066 * @param vals メ?ージの引数(??配?)
067 *
068 * @return ラベルインターフェースの引数付きメ?ージ
069 */
070 String getMessage( String[] vals ) ;
071
072 /**
073 * ラベルインターフェースの名前(短)を返します?
074 * 概要説明がな??合でかつ??上?SNAMEが未設定?場合??
075 * LNAME が返されます?SNAMEが設定されて?場合??
076 * ??ルチップにLNAME が表示されます?
077 * 概要説明が存在する場合?、ツールチップに概要説明が
078 * 表示されます?
079 *
080 * @return ラベルインターフェースの名前(短)
081 */
082 String getShortLabel() ;
083
084 /**
085 * ラベルインターフェースの名前(長)を返します?
086 * 概要説明が存在する場合?、ツールチップに概要説明が
087 * 表示されます?
088 *
089 * @return ラベルインターフェースの名前(長)
090 * @see #getLongLabel( String )
091 */
092 String getLongLabel() ;
093
094 /**
095 * ラベルインターフェースの名前(長)を返します?
096 * ??ルチップに表示するタイトル属?(概要説?を置き換えます?
097 * null の場合?、既存?getLongLabel()を返します?
098 *
099 * @param title ??ルチップに表示するタイトル属?
100 *
101 * @return ラベルインターフェースの名前(長)
102 * @see #getLongLabel()
103 */
104 String getLongLabel( String title ) ;
105
106 /**
107 * ラベルインターフェースの概要説明を返します?
108 * 概要説明が存在する場合?、ラベルの??ルチップに
109 * 概要説明が表示されます?
110 *
111 * @return ラベルインターフェースの概要説?
112 */
113 String getDescription() ;
114
115 /**
116 * ラベルインターフェースの引数付きメ?ージを返します?
117 * 概?対応方?の引数部?、文字?配?を適用して、MessageFormat
118 * で変換した結果を返します?(MessageData でのみ有効です?)
119 *
120 * @og.rev 4.3.7.6 (2009/07/15) 新規作?
121 *
122 * @param vals パラメータ
123 *
124 * @return ラベルインターフェースの引数付き概?
125 */
126 String getDescription( String[] vals ) ;
127
128 /**
129 * リソース??から作?されたかど?を返します?
130 * 正式な場合?、true / リソースになく?独自に作?された?合?、false になります?
131 *
132 * @return リソース??から作?されたかど?
133 */
134 boolean isOfficial() ;
135 }