| RoleService.java |
1 /**
2 * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.service;
24
25 /**
26 * <a href="RoleService.java.html"><b><i>View Source</i></b></a>
27 *
28 * <p>
29 * ServiceBuilder generated this class. Modifications in this class will be overwritten
30 * the next time is generated.
31 * </p>
32 *
33 * <p>
34 * This interface defines the service. The default implementation is <code>com.liferay.portal.service.impl.RoleServiceImpl</code>.
35 * Modify methods in that class and rerun ServiceBuilder to populate this class
36 * and all other generated classes.
37 * </p>
38 *
39 * <p>
40 * This is a remote service. Methods of this service are expected to have security
41 * checks based on the propagated JAAS credentials because this service can be accessed
42 * remotely.
43 * </p>
44 *
45 * @author Brian Wing Shun Chan
46 *
47 * @see com.liferay.portal.service.RoleServiceFactory
48 * @see com.liferay.portal.service.RoleServiceUtil
49 *
50 */
51 public interface RoleService {
52 public com.liferay.portal.model.Role addRole(java.lang.String name, int type)
53 throws com.liferay.portal.SystemException,
54 com.liferay.portal.PortalException, java.rmi.RemoteException;
55
56 public void deleteRole(long roleId)
57 throws com.liferay.portal.SystemException,
58 com.liferay.portal.PortalException, java.rmi.RemoteException;
59
60 public com.liferay.portal.model.Role getGroupRole(long companyId,
61 long groupId)
62 throws com.liferay.portal.SystemException,
63 com.liferay.portal.PortalException, java.rmi.RemoteException;
64
65 public java.util.List getGroupRoles(long groupId)
66 throws com.liferay.portal.SystemException,
67 com.liferay.portal.PortalException, java.rmi.RemoteException;
68
69 public com.liferay.portal.model.Role getRole(long roleId)
70 throws com.liferay.portal.SystemException,
71 com.liferay.portal.PortalException, java.rmi.RemoteException;
72
73 public com.liferay.portal.model.Role getRole(long companyId,
74 java.lang.String name)
75 throws com.liferay.portal.SystemException,
76 com.liferay.portal.PortalException, java.rmi.RemoteException;
77
78 public java.util.List getUserGroupRoles(long userId, long groupId)
79 throws com.liferay.portal.SystemException,
80 com.liferay.portal.PortalException, java.rmi.RemoteException;
81
82 public java.util.List getUserRelatedRoles(long userId, java.util.List groups)
83 throws com.liferay.portal.SystemException,
84 com.liferay.portal.PortalException, java.rmi.RemoteException;
85
86 public java.util.List getUserRoles(long userId)
87 throws com.liferay.portal.SystemException,
88 com.liferay.portal.PortalException, java.rmi.RemoteException;
89
90 public boolean hasUserRole(long userId, long companyId,
91 java.lang.String name, boolean inherited)
92 throws com.liferay.portal.SystemException,
93 com.liferay.portal.PortalException, java.rmi.RemoteException;
94
95 public boolean hasUserRoles(long userId, long companyId,
96 java.lang.String[] names, boolean inherited)
97 throws com.liferay.portal.SystemException,
98 com.liferay.portal.PortalException, java.rmi.RemoteException;
99
100 public com.liferay.portal.model.Role updateRole(long roleId,
101 java.lang.String name)
102 throws com.liferay.portal.SystemException,
103 com.liferay.portal.PortalException, java.rmi.RemoteException;
104 }