accountdao.java

Chinaxp 论坛源代码

/*
 * XP Forum
 *
 * Copyright (c) 2002-2003 RedSoft Group.  All rights reserved.
 *
 */
package org.redsoft.forum.dao;

import org.redsoft.forum.exception.AccountAlreadyExistException;
import org.redsoft.forum.exception.AccountNotFoundException;
import org.redsoft.forum.exception.DAOException;

import java.util.Collection;

/**
 * Account DAO interface
 *
 * @author charles Huang
 * @version 1.0
 */

public interface AccountDAO {

    /**
     *  Add a user account
     *
     * @param account - A account object that contains the user info,like userName,
     *                  password,email
     * @exception DAOException - Thrown if a db error happens
     */
    public void addAccount( final Account account ) throws DAOException,AccountAlreadyExistException;

    /**
     *  Edit a user account
     *
     * @param account - A account object that contains the user info,like userName,
     *                  password,email
     * @exception DAOException - Thrown if a db error happens
     * @exception AccountNotFoundException
     */
    public void updateAccount( final Account account ) throws DAOException,AccountNotFoundException;

    /**
     *  Find a user given a user name
     *
     * @param userName - The user name
     * @return Account - A account object that contains the user info
     * @exception DAOException - Thrown if a db error happens
     * @exception AccountNotFoundException
     */
    public Account findByUserName( final String userName )
                                               throws DAOException,
                                                      AccountNotFoundException;

    /**
     *  Remove a account given a user name
     *
     *  @param userName - User name
     */
    public void removeAccount( final String userName ) throws DAOException;

    /**
     * Find all columnWriters
     * @return
     * @throws DAOException
     */
    public Collection findColumnWriters() throws DAOException;

}