KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ivata > groupware > admin > setting > right > SettingsRights


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: SettingsRights.java,v $
31  * Revision 1.2 2005/04/09 17:19:05 colinmacleod
32  * Changed copyright text to GPL v2 explicitly.
33  *
34  * Revision 1.1.1.1 2005/03/10 17:50:38 colinmacleod
35  * Restructured ivata op around Hibernate/PicoContainer.
36  * Renamed ivata groupware.
37  *
38  * Revision 1.2 2004/11/12 15:56:46 colinmacleod
39  * Removed dependencies on SSLEXT.
40  * Moved Persistence classes to ivata masks.
41  *
42  * Revision 1.1 2004/07/13 19:41:12 colinmacleod
43  * Moved project to POJOs from EJBs.
44  * Applied PicoContainer to services layer (replacing session EJBs).
45  * Applied Hibernate to persistence layer (replacing entity EJBs).
46  * -----------------------------------------------------------------------------
47  */
48 package com.ivata.groupware.admin.setting.right;
49
50 import com.ivata.groupware.admin.security.server.SecuritySession;
51 import com.ivata.mask.util.SystemException;
52
53 /**
54  * @author Colin MacLeod
55  * <a HREF='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
56  * @since Apr 16, 2004
57  * @version $Revision: 1.2 $
58  */
59 public interface SettingsRights {
60     /**
61      * <p>this method sets a setting to be allowed for users to override the
62      * system value</p>, {see canAmendSetting(name)}
63      * @param name the name of the setting
64      *
65      * @ejb.interface-method
66      * view-type="both"
67      */
68     public void addAmendRightForSetting(final
69         SecuritySession securitySession,
70             final String JavaDoc settingName)
71         throws SystemException;
72     /**
73      * <p>the method finds out whether a setting can be changed (overriden) by
74      * a user</p>
75      * @param name the name of the setting
76      * @return <code>true</code> when this setting can be overridden by user,
77      * <code>false</code> otherwise
78      *
79      * @ejb.interface-method
80      * view-type="both"
81      */
82     public boolean canAmendSetting(final
83         SecuritySession securitySession,
84             final String JavaDoc settingName)
85         throws SystemException;
86     /**
87      * <p>the method tells whether a user can amend system settings</p>
88      * @param userName the name of the user
89      * @return <code>true</code> when this user can amend system settings or
90      * <code>false</code> when he can't
91      *
92      * @ejb.interface-method
93      * view-type="both"
94      */
95     public boolean canAmendSystemSettings(final SecuritySession securitySession)
96         throws SystemException;
97     /**
98      * <p>this method disables overriding the system value of one setting,
99      * {see canAmendSetting(name)}
100      * @param name the name of the setting
101      *
102      * @ejb.interface-method
103      * view-type="both"
104      */
105     public void removeAmendRightForSetting(final
106         SecuritySession securitySession,
107             final String JavaDoc settingName)
108         throws SystemException;
109 }
Popular Tags