KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > appfuse > service > UserWebService


1 package org.appfuse.service;
2
3 import java.util.List JavaDoc;
4
5 import org.appfuse.dao.UserDao;
6 import org.appfuse.model.User;
7
8
9 /**
10  * WebService Interface
11  *
12  * <p><a HREF="UserWebService.java.htm"><i>View Source</i></a></p>
13  *
14  * @author <a HREF="mailto:mikagoeckel@codehaus.org">Mika Goeckel</a>
15  * @aegis.mapping
16  */
17 public interface UserWebService {
18     //~ Methods ================================================================
19
20     /**
21      * Retrieves a user by username. An exception is thrown if now user
22      * is found.
23      *
24      * @param username
25      * @return User
26      */
27     public User getUser(String JavaDoc username);
28
29     /**
30      * Retrieves a list of users, filtering with parameters on a user object
31      * @param user parameters to filter on
32      * @return List
33      *
34      * Tell xfire, which objects it will find in the List
35      * @aegis.method
36      * @aegis.method-return-type componentType="org.appfuse.model.User"
37      */
38     public List JavaDoc getUsers(User user);
39
40     /**
41      * Saves a user's information
42      *
43      * @param user the user's information
44      * @throws UserExistsException
45      */
46     public void saveUser(User user) throws UserExistsException;
47
48     /**
49      * Removes a user from the database by their username
50      *
51      * @param username the user's username
52      */
53     public void removeUser(String JavaDoc username);
54 }
55
Popular Tags