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