KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > appfuse > dao > UserDao


1 package org.appfuse.dao;
2
3 import java.util.List JavaDoc;
4
5 import org.acegisecurity.userdetails.UserDetails;
6 import org.acegisecurity.userdetails.UsernameNotFoundException;
7 import org.appfuse.model.User;
8
9 /**
10  * User Data Access Object (Dao) interface.
11  *
12  * <p>
13  * <a HREF="UserDao.java.htm"><i>View Source</i></a>
14  * </p>
15  *
16  * @author <a HREF="mailto:matt@raibledesigns.com">Matt Raible</a>
17  */

18 public interface UserDao extends Dao {
19     /**
20      * Gets users information based on user id.
21      * @param userId the user's id
22      * @return user populated user object
23      */

24     public User getUser(Long JavaDoc userId);
25
26     /**
27      * Gets users information based on login name.
28      * @param username the user's username
29      * @return userDetails populated userDetails object
30      */

31     public UserDetails loadUserByUsername(String JavaDoc username) throws UsernameNotFoundException;
32     
33     /**
34      * Gets a list of users based on parameters passed in.
35      *
36      * @return List populated list of users
37      */

38     public List JavaDoc getUsers(User user);
39
40     /**
41      * Saves a user's information
42      * @param user the object to be saved
43      */

44     public void saveUser(User user);
45
46     /**
47      * Removes a user from the database by id
48      * @param userId the user's id
49      */

50     public void removeUser(Long JavaDoc userId);
51 }
52
Popular Tags