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.resource;
017
018import static org.opengion.fukurou.system.HybsConst.CR;                         // 6.1.0.0 (2014/12/26)
019import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
020
021/**
022 * ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの元となる、ﾕｰｻﾞｰｱｸｾｽ画面ﾃﾞｰﾀを作成します。
023 *
024 * @og.rev 4.1.1.0 (2008/01/22) 新規作成
025 * @og.group ﾘｿｰｽ管理
026 *
027 * @version     4.1.1.0
028 * @author      Sen.Li
029 * @since       JDK5.0,
030 */
031public final class FavoriteGUIData {
032
033        private final String    guiKey          ;                                       // 画面ID
034        private final int               seqno           ;                                       // 表示順
035        private final String    name            ;                                       // 名称(漢字)
036        private final String    classify        ;                                       // 分類
037
038        /**
039         * 引数を元に、FavoriteGUIDataオブジェクトを構築します。
040         *
041         * @param       parmGuiKey              お気に入り画面の画面ID
042         * @param       parmSeqno               お気に入り画面の表示順
043         * @param       parmName                お気に入り画面の名称(漢字)
044         * @param       parmClassify    お気に入り画面の分類
045         */
046        /* default */ FavoriteGUIData( final String parmGuiKey,final String parmSeqno,final String parmName,final String parmClassify ) {
047                guiKey          = parmGuiKey;                                                   // 画面ID
048                seqno           = Integer.parseInt( parmSeqno );                // 表示順
049                name            = parmName;                                                             // 名称(漢字)
050                classify        = parmClassify;                                                 // 分類
051        }
052
053        /**
054         * ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄのｷｰを返します。
055         *
056         * @return      ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄのｷｰ
057         */
058        public String getGuiKey() { return guiKey; }
059
060        /**
061         * ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの表示順を返します。
062         *
063         * @return      ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの表示順
064         */
065        public int getSeqno() { return seqno; }
066
067        /**
068         * ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの名称(漢字)を返します。
069         *
070         * @return      ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの名称(漢字)
071         */
072        public String getName() { return name; }
073
074        /**
075         * ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの分類を返します。
076         *
077         * @return      ﾕｰｻﾞｰｱｸｾｽ画面ｵﾌﾞｼﾞｪｸﾄの分類
078         */
079        public String getClassify() { return classify; }
080
081        /**
082         * ｵﾌﾞｼﾞｪｸﾄの識別子として、詳細なﾕｰｻﾞｰｱｸｾｽ画面情報を返します。
083         *
084         * @return      詳細なﾕｰｻﾞｰｱｸｾｽ画面情報
085         * @og.rtnNotNull
086         */
087        @Override
088        public String toString() {
089                final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE )
090                        .append( "guiKey   :" ).append( guiKey   ).append( CR )
091                        .append( "seqno    :" ).append( seqno    ).append( CR )
092                        .append( "name     :" ).append( name     ).append( CR )
093                        .append( "classify :" ).append( classify ).append( CR );
094                return rtn.toString();
095        }
096}