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.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="RoleLocalService.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.RoleLocalServiceImpl</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 local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portal.service.RoleLocalServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface RoleLocalService {
57      public com.liferay.portal.model.Role addRole(
58          com.liferay.portal.model.Role role)
59          throws com.liferay.portal.SystemException;
60  
61      public com.liferay.portal.model.Role createRole(long roleId);
62  
63      public void deleteRole(long roleId)
64          throws com.liferay.portal.SystemException,
65              com.liferay.portal.PortalException;
66  
67      public void deleteRole(com.liferay.portal.model.Role role)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
72          throws com.liferay.portal.SystemException;
73  
74      public java.util.List<Object> dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portal.model.Role getRole(long roleId)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public java.util.List<com.liferay.portal.model.Role> getRoles(int start,
85          int end) throws com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getRolesCount() throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Role updateRole(
91          com.liferay.portal.model.Role role)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portal.model.Role addRole(long userId, long companyId,
95          java.lang.String name, java.lang.String description, int type)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public com.liferay.portal.model.Role addRole(long userId, long companyId,
100         java.lang.String name, java.lang.String description, int type,
101         java.lang.String className, long classPK)
102         throws com.liferay.portal.PortalException,
103             com.liferay.portal.SystemException;
104 
105     public void addUserRoles(long userId, long[] roleIds)
106         throws com.liferay.portal.SystemException;
107 
108     public void checkSystemRoles(long companyId)
109         throws com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException;
111 
112     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113     public com.liferay.portal.model.Role getGroupRole(long companyId,
114         long groupId)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119     public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
120         long groupId) throws com.liferay.portal.SystemException;
121 
122     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
123     public java.util.Map<String, java.util.List<String>> getResourceRoles(
124         long companyId, java.lang.String name, int scope,
125         java.lang.String primKey) throws com.liferay.portal.SystemException;
126 
127     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
128     public com.liferay.portal.model.Role getRole(long companyId,
129         java.lang.String name)
130         throws com.liferay.portal.PortalException,
131             com.liferay.portal.SystemException;
132 
133     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
134     public java.util.List<com.liferay.portal.model.Role> getRoles(
135         long companyId) throws com.liferay.portal.SystemException;
136 
137     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
138     public java.util.List<com.liferay.portal.model.Role> getRoles(
139         long[] roleIds)
140         throws com.liferay.portal.PortalException,
141             com.liferay.portal.SystemException;
142 
143     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
144     public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
145         long userId, long groupId) throws com.liferay.portal.SystemException;
146 
147     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
148     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
149         long userId, long groupId) throws com.liferay.portal.SystemException;
150 
151     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
153         long userId, long[] groupIds) throws com.liferay.portal.SystemException;
154 
155     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
156     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
157         long userId, java.util.List<com.liferay.portal.model.Group> groups)
158         throws com.liferay.portal.SystemException;
159 
160     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
161     public java.util.List<com.liferay.portal.model.Role> getUserRoles(
162         long userId) throws com.liferay.portal.SystemException;
163 
164     public boolean hasUserRole(long userId, long roleId)
165         throws com.liferay.portal.SystemException;
166 
167     public boolean hasUserRole(long userId, long companyId,
168         java.lang.String name, boolean inherited)
169         throws com.liferay.portal.PortalException,
170             com.liferay.portal.SystemException;
171 
172     public boolean hasUserRoles(long userId, long companyId,
173         java.lang.String[] names, boolean inherited)
174         throws com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException;
176 
177     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178     public java.util.List<com.liferay.portal.model.Role> search(
179         long companyId, java.lang.String name, java.lang.String description,
180         java.lang.Integer type, int start, int end,
181         com.liferay.portal.kernel.util.OrderByComparator obc)
182         throws com.liferay.portal.SystemException;
183 
184     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185     public java.util.List<com.liferay.portal.model.Role> search(
186         long companyId, java.lang.String name, java.lang.String description,
187         java.lang.Integer type, java.util.LinkedHashMap<String, Object> params,
188         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
189         throws com.liferay.portal.SystemException;
190 
191     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192     public int searchCount(long companyId, java.lang.String name,
193         java.lang.String description, java.lang.Integer type)
194         throws com.liferay.portal.SystemException;
195 
196     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197     public int searchCount(long companyId, java.lang.String name,
198         java.lang.String description, java.lang.Integer type,
199         java.util.LinkedHashMap<String, Object> params)
200         throws com.liferay.portal.SystemException;
201 
202     public void setUserRoles(long userId, long[] roleIds)
203         throws com.liferay.portal.PortalException,
204             com.liferay.portal.SystemException;
205 
206     public void unsetUserRoles(long userId, long[] roleIds)
207         throws com.liferay.portal.SystemException;
208 
209     public com.liferay.portal.model.Role updateRole(long roleId,
210         java.lang.String name,
211         java.util.Map<java.util.Locale, String> localeTitlesMap,
212         java.lang.String description, java.lang.String subtype)
213         throws com.liferay.portal.PortalException,
214             com.liferay.portal.SystemException;
215 }