iusermanager.java.svn-base

使用OSGi框架开发的分布式电子辞典

/*
 * @(#)IUserManager.java
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
package cn.edu.ynu.sei.dict.plugin.user.service;

import cn.edu.ynu.sei.dict.core.exception.AlreadyExsistException;
import cn.edu.ynu.sei.dict.core.exception.NotFoundUserException;
import cn.edu.ynu.sei.dict.core.service.User;
import java.util.List;

/**
 * Using this <code>interface</code> we can create a new user, update a
 * user's information, and so on.
 * @author zy
 * @author 88250
 * @version 1.0.0.1, Mar 14, 2008
 */
public interface IUserManager {

    /**
     * Get all subscriptions of a user.
     * @param userName the sepecified user's name
     * @return subscription list, if the specified user has no 
     *         subscription, returns <code>null</code>
     */
    List<String> findAllSubscriptions(String userName);

    /**
     * Add some subscriptions for a user.
     * @param userName the name of the user
     * @param attenName the name of the user who is payed attention
     * @throws cn.edu.ynu.sei.dict.core.exception.AlreadyExsistException
     *           when a user want to add another user to his list,if the user he added already exisits in his list,throw.
     * @throws cn.edu.ynu.sei.dict.core.exception.NotFoundUserException
     *           when a user want to add another user to his list,if the user he added does not exisit,throw.
     */
    void addSubscriptions(String userName, String attenName) throws AlreadyExsistException, NotFoundUserException;

    /**
     * Delete a user's subscriptions.
     * @param userName the name of the user
     * @param attenName the name of the user who is payed attention
     */
    void deleteSubscriptions(String userName, String attenName);

    /**
     * Delete a user according the user name.
     * @param user the specified user name
     * the user to be deleted
     */
    void deleteUserByName(User user);

    /**
     * Get all users.
     * @return a user list contains all user
     */
    List<User> findAll();

    /**
     * Get a user according the user's name.
     * @param name the specified user name
     * @return a particular user,if failed <code>return null</code>
     */
    User getUserByUserName(String name);

    /**
     * Get names of all users'.
     * @return a list contain all user name
     */
    List<String> getUserNames();

    /**
     * Sava the sepecified user's information.
     * @param user the user to be saved
     */
    void persistUser(User user);

    /**
     * Update a user's information.
     * @param user the user to be updated
     */
    void updateUserPersonalInfo(User user);
}