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.common;
017
018import org.opengion.fukurou.util.Cleanable;
019
020/**
021 * ﾕｰｻﾞｰ情報(UserInfo)のｻﾏﾘｰ情報のみﾊﾝﾄﾞﾘﾝｸﾞする為のｲﾝﾀｰﾌｪｰｽです。
022 * ﾊﾟｯｹｰｼﾞ間依存を減らす為に、新規作成しています。
023 * よって、resource/UserInfo の部分ﾒｿｯﾄﾞのみをｻﾎﾟｰﾄしていると考えてください。
024 *
025 * @og.rev 4.0.0.0 (2005/08/31) 新規作成
026 * @og.group ﾛｸﾞｲﾝ制御
027 *
028 * @version     4.0
029 * @author      Kazuhiko Hasegawa
030 * @since       JDK5.0,
031 */
032public interface UserSummary extends Comparable<UserSummary> , Cleanable {
033
034        /**
035         * ﾕｰｻﾞｰﾛｸﾞｲﾝ時刻を取得します。
036         *
037         * @return      ﾕｰｻﾞｰﾛｸﾞｲﾝ時刻
038         */
039        long getLoginTime() ;
040
041        /**
042         * ﾕｰｻﾞｰのﾛｸﾞｲﾝIPｱﾄﾞﾚｽを取得します。
043         *
044         * @return      IPｱﾄﾞﾚｽ
045         */
046        String getIPAddress() ;
047
048        /**
049         * ﾕｰｻﾞｰを返します。
050         *
051         * @return      ﾕｰｻﾞｰ
052         */
053        String getUserID() ;
054
055        /**
056         * ﾕｰｻﾞｰ情報ﾛｹｰﾙ(言語)を返します。
057         *
058         * @return      ﾛｹｰﾙ(言語)
059         */
060        String getLang() ;
061
062        /**
063         * ﾕｰｻﾞｰ情報 名称(日本語)を返します。
064         *
065         * @return      名称(日本語)
066         */
067        String getJname() ;
068
069        /**
070         * ﾕｰｻﾞｰ情報 ﾛｰﾙ(役割)を取得します。
071         *
072         * @return      ﾛｰﾙ(役割)
073         */
074        String getRoles() ;
075
076        /**
077         * ｵﾌﾞｼﾞｪｸﾄの識別子として、ﾕｰｻﾞｰ情報を返します。
078         *
079         * @return      ﾕｰｻﾞｰ情報
080         */
081        String getInfo() ;
082
083        /**
084         * ﾕｰｻﾞｰ情報の属性文字列を取得します。
085         *
086         * @param       key     ｷｰ
087         * @return      属性文字列
088         * @see org.opengion.hayabusa.resource.UserInfo#getAttribute( String )
089         */
090        String getAttribute( final String key ) ;
091
092}