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     */
016    package org.opengion.hayabusa.common;
017    
018    import 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     */
032    public 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             *
088             * @return  属æ?æ–?­—å?
089             * @see org.opengion.hayabusa.resource.UserInfo#getAttribute( String )
090             */
091            String getAttribute( final String key ) ;
092    
093            /**
094             * ã“ã?ã‚ªãƒ–ã‚¸ã‚§ã‚¯ãƒˆã¨æŒ?®šã•れãŸã‚ªãƒ–ジェクトã?é ?ºã‚’比è¼?—ã¾ã™ã?
095             *
096             * ã“ã?ã‚ªãƒ–ã‚¸ã‚§ã‚¯ãƒˆãŒæŒ?®šã•れãŸã‚ªãƒ–ジェクトよりå°ã•ã??åˆã?è²??æ•´æ•°ã€ç­‰ã—ã??åˆã?ゼロã€å¤§ãã„å ´åˆã?æ­£ã®æ•´æ•°ã‚’è¿”ã—ã¾ã™ã?
097             *
098             * @param  o1   比è¼?¯¾è±¡ã®ã‚ªãƒ–ジェクãƒ?
099             *
100             * @return      ã“ã?ã‚ªãƒ–ã‚¸ã‚§ã‚¯ãƒˆãŒæŒ?®šã•れãŸã‚ªãƒ–ジェクトよりå°ã•ã??åˆã?è²??æ•´æ•°ã€ç­‰ã—ã??åˆã?ゼロã€å¤§ãã„å ´åˆã?æ­£ã®æ•´æ•°
101             */
102            int compareTo( UserSummary o1 ) ;
103    }