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