01: /*
02: * $Id: Usergroup.java 636 2006-04-20 00:14:40Z wrh2 $
03: *
04: * Filename : Usergroup.java
05: * Created : 25.06.2004
06: * Project : VQWiki
07: */
08: package vqwiki.users;
09:
10: import java.util.List;
11:
12: /**
13: * Abstract class to handle user groups
14: *
15: * @version $Revision: 636 $ - $Date: 2006-04-20 02:14:40 +0200 (do, 20 apr 2006) $
16: * @author SinnerSchrader (tobsch)
17: */
18: public abstract class Usergroup {
19:
20: /**
21: * Get an instance of the user group class.
22: * @return Instance to the user group class
23: */
24: public static Usergroup getInstance() {
25: return null;
26: }
27:
28: /**
29: * Get a list of all users.
30: * @return List of all users. The list contains SelectorBeans with the user-ID as key and the full
31: * username as label.
32: * @see vqwiki.servlets.beans.SelectorBean
33: */
34: public abstract List getListOfAllUsers();
35:
36: /**
37: * Get the full name of an user by its user-ID
38: * @param uid The user-ID of this user
39: * @return The full name of this user
40: */
41: public abstract String getFullnameById(String uid);
42:
43: /**
44: * Get the email address of an user by its user-ID
45: * @param uid The user-ID of this user
46: * @return The email address of this user
47: */
48: public abstract String getKnownEmailById(String user);
49:
50: /**
51: * Get the user details of this user by its user-ID. The user details is a string, which is
52: * set in the admin section. It contains some placeholders, which are replaced by values from
53: * the user repository
54: * @param uid The user-ID of this user
55: * @return The user details section
56: */
57: public abstract String getUserDetails(String uid);
58:
59: /**
60: * Contains the repository valid (already confirmed) email addresses?
61: * If yes, then we can skip the registration process and the user is automatically registered.
62: * @return true, if so. false otherwise.
63: */
64: public boolean isEmailValidated() {
65: return false;
66: }
67:
68: }
69: /*
70: * Log:
71: *
72: * $Log$
73: * Revision 1.2 2006/04/20 00:14:40 wrh2
74: * Coding style updates (VQW-73).
75: *
76: * Revision 1.1 2004/06/28 09:37:19 mrgadget4711
77: * Classes for User groups
78: *
79: * ------------END------------
80: */
|