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