1   /**
2    * Copyright (c) 2000-2008 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  /**
27   * <a href="RoleService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.RoleServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.RoleServiceUtil
48   *
49   */
50  public interface RoleService {
51      public com.liferay.portal.model.Role addRole(java.lang.String name,
52          java.lang.String description, int type)
53          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
54              com.liferay.portal.SystemException;
55  
56      public void addUserRoles(long userId, long[] roleIds)
57          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
58              com.liferay.portal.SystemException;
59  
60      public void deleteRole(long roleId)
61          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
62              com.liferay.portal.SystemException;
63  
64      public com.liferay.portal.model.Role getGroupRole(long companyId,
65          long groupId)
66          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
67              com.liferay.portal.SystemException;
68  
69      public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
70          long groupId)
71          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
72  
73      public com.liferay.portal.model.Role getRole(long roleId)
74          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException;
76  
77      public com.liferay.portal.model.Role getRole(long companyId,
78          java.lang.String name)
79          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException;
81  
82      public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
83          long userId, long groupId)
84          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
85  
86      public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
87          long userId, java.util.List<com.liferay.portal.model.Group> groups)
88          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
89  
90      public java.util.List<com.liferay.portal.model.Role> getUserRoles(
91          long userId)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
93  
94      public boolean hasUserRole(long userId, long companyId,
95          java.lang.String name, boolean inherited)
96          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public boolean hasUserRoles(long userId, long companyId,
100         java.lang.String[] names, boolean inherited)
101         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
102             com.liferay.portal.SystemException;
103 
104     public void unsetUserRoles(long userId, long[] roleIds)
105         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public com.liferay.portal.model.Role updateRole(long roleId,
109         java.lang.String name, java.lang.String description)
110         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException;
112 }