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