KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ivata > groupware > admin > security > addressbook > AddressBookSecurity


1 /*
2  * Copyright (c) 2001 - 2005 ivata limited.
3  * All rights reserved.
4  * -----------------------------------------------------------------------------
5  * ivata groupware may be redistributed under the GNU General Public
6  * License as published by the Free Software Foundation;
7  * version 2 of the License.
8  *
9  * These programs are free software; you can redistribute them and/or
10  * modify them under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; version 2 of the License.
12  *
13  * These programs are distributed in the hope that they will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  * See the GNU General Public License in the file LICENSE.txt for more
18  * details.
19  *
20  * If you would like a copy of the GNU General Public License write to
21  *
22  * Free Software Foundation, Inc.
23  * 59 Temple Place - Suite 330
24  * Boston, MA 02111-1307, USA.
25  *
26  *
27  * To arrange commercial support and licensing, contact ivata at
28  * http://www.ivata.com/contact.jsp
29  * -----------------------------------------------------------------------------
30  * $Log: AddressBookSecurity.java,v $
31  * Revision 1.3 2005/04/10 20:32:02 colinmacleod
32  * Added new themes.
33  * Changed id type to String.
34  * Changed i tag to em and b tag to strong.
35  * Improved PicoContainerFactory with NanoContainer scripts.
36  *
37  * Revision 1.2 2005/04/09 17:19:04 colinmacleod
38  * Changed copyright text to GPL v2 explicitly.
39  *
40  * Revision 1.1.1.1 2005/03/10 17:50:44 colinmacleod
41  * Restructured ivata op around Hibernate/PicoContainer.
42  * Renamed ivata groupware.
43  *
44  * Revision 1.2 2004/11/12 15:56:43 colinmacleod
45  * Removed dependencies on SSLEXT.
46  * Moved Persistence classes to ivata masks.
47  *
48  * Revision 1.1 2004/09/30 15:15:32 colinmacleod
49  * Split off addressbook elements into security subproject.
50  *
51  * Revision 1.1 2004/07/13 19:41:11 colinmacleod
52  * Moved project to POJOs from EJBs.
53  * Applied PicoContainer to services layer (replacing session EJBs).
54  * Applied Hibernate to persistence layer (replacing entity EJBs).
55  * -----------------------------------------------------------------------------
56  */
57 package com.ivata.groupware.admin.security.addressbook;
58
59 import com.ivata.groupware.admin.security.Security;
60 import com.ivata.groupware.admin.security.server.SecuritySession;
61 import com.ivata.groupware.business.addressbook.person.PersonDO;
62 import com.ivata.mask.util.SystemException;
63
64 /**
65  * @author Colin MacLeod
66  * <a HREF='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
67  * @since Mar 29, 2004
68  * @version $Revision: 1.3 $
69  */
70 public interface AddressBookSecurity extends Security {
71
72     /**
73      * <p>Add a new user to the system. The person's details must first have
74      * been entered into the address book.</p>
75      *
76      * <p><strong>Note:</strong> This routine will fail if the person has no email
77      * address!</p>
78      *
79      * @param userName the name of the user who is adding the new user to the
80      * system. <strong>This is not the user name of the new user!</strong>
81      * @param person the person, with the user object set in it.
82      * @throws InvalidFieldValueException if any of the fields supplied are
83      * <code>null</code>.
84      */
85     public void addUserToPerson(final
86         SecuritySession securitySession,
87             final PersonDO person)
88         throws SystemException;
89 }
Popular Tags