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 */
016package org.opengion.hayabusa.db;
017
018/**
019 * データのコード情報を取り扱う共通インターフェースです。
020 *
021 * コードのキーとラベルの情報から、HTMLのメニューやリストを作成するための オプション
022 * タグを作成したり、与えられたキーをもとに、チェック済みのオプションタグを作成したり
023 * します。
024 *
025 * @og.group 選択データ制御
026 *
027 * @version  4.0
028 * @author   Kazuhiko Hasegawa
029 * @since    JDK5.0,
030 */
031public interface Selection {
032        /** オプションなし */
033        String NO_VALUE_OPTION = "<option value=\"\" ></option>" ;      // 3.5.5.7 (2004/05/10)
034
035        /**
036         * 初期値が選択済みの 選択肢(オプション)を返します。
037         * このオプションは、引数の値を初期値とするオプションタグを返します。
038         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
039         * ツールチップ表示を行います。
040         *
041         * @og.rev 5.1.3.0 (2010/02/01) 追加
042         *
043         * @param   selectValue  選択されている値
044         * @param   seqFlag  シーケンスアクセス機能 [true:ON/false:OFF]
045         * @param   useShortLabel ラベル(短)をベースとしたオプション表示を行うかどうか。
046         *
047         * @return  オプションタグ
048         */
049        String getOption( String selectValue,boolean seqFlag, boolean useShortLabel ) ;
050
051        /**
052         * 初期値が選択済みの 選択肢(オプション)を返します。
053         * このオプションは、引数の値を初期値とするオプションタグを返します。
054         * このメソッドでは、引数のuseShortLabelがtrueに指定された場合に、ラベル(短)をベースとした
055         * ツールチップ表示を行います。
056         * これは、ラジオボタンやチェックボックスなど、１コードデータ単位に name を指定する
057         * 場合に使います。
058         * 旧 #getRadio( String , String , boolean ) メソッドの代替えです。
059         *
060         * @og.rev 6.2.2.4 (2015/04/24) 新規追加。旧 #getRadio( String , String , boolean ) メソッドの代替えです。
061         *
062         * @param   name  name属性になるキー文字列
063         * @param   selectValue  選択されている値
064         * @param   useLabel     ラベル表示の有無 [true:有/false:無]
065         *
066         * @return  オプションタグ
067         */
068        String getOption( String name, String selectValue,boolean useLabel ) ;
069
070        /**
071         * 選択肢(value)に対するラベルを返します。
072         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
073         * getValueLabel( XX ) は、getValueLabel( XX,false ) と同じです。
074         *
075         * @param   selectValue 選択肢の値
076         *
077         * @return  選択肢のラベル
078         * @see     #getValueLabel( String,boolean )
079         */
080        String getValueLabel( String selectValue ) ;
081
082        /**
083         * 選択肢(value)に対するラベルを返します。
084         * 選択肢(value)が、存在しなかった場合は、選択肢そのものを返します。
085         * このメソッドでは、短縮ラベルを返すかどうかを指定するフラグを指定します。
086         * getValueLabel( XX,false ) は、getValueLabel( XX ) と同じです。
087         *
088         * @og.rev 4.0.0.0 (2005/11/30) を追加
089         *
090         * @param       selectValue     選択肢の値
091         * @param       isSLbl  短縮ラベル使用有無 [true:使用する/false:しない]
092         *
093         * @return  選択肢のラベル
094         * @see     #getValueLabel( String )
095         */
096        String getValueLabel( String selectValue,boolean isSLbl ) ;
097
098        /**
099         * オブジェクトのキャッシュが時間切れかどうかを返します。
100         * キャッシュが時間切れ(無効)であれば、true を、有効であれば、
101         * false を返します。
102         *
103         * @og.rev 4.0.0.0 (2005/01/31) 新規作成
104         *
105         * @return  キャッシュが時間切れなら true
106         */
107        boolean isTimeOver() ;
108}