1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Isolation;
25  import com.liferay.portal.kernel.annotation.Propagation;
26  import com.liferay.portal.kernel.annotation.Transactional;
27  
28  /**
29   * <a href="RoleLocalService.java.html"><b><i>View Source</i></b></a>
30   *
31   * <p>
32   * ServiceBuilder generated this class. Modifications in this class will be
33   * overwritten the next time is generated.
34   * </p>
35   *
36   * <p>
37   * This interface defines the service. The default implementation is
38   * <code>com.liferay.portal.service.impl.RoleLocalServiceImpl</code>.
39   * Modify methods in that class and rerun ServiceBuilder to populate this class
40   * and all other generated classes.
41   * </p>
42   *
43   * <p>
44   * 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.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.RoleLocalServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface RoleLocalService {
55      public com.liferay.portal.model.Role addRole(
56          com.liferay.portal.model.Role role)
57          throws com.liferay.portal.SystemException;
58  
59      public com.liferay.portal.model.Role createRole(long roleId);
60  
61      public void deleteRole(long roleId)
62          throws com.liferay.portal.SystemException,
63              com.liferay.portal.PortalException;
64  
65      public void deleteRole(com.liferay.portal.model.Role role)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<Object> dynamicQuery(
69          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
70          throws com.liferay.portal.SystemException;
71  
72      public java.util.List<Object> dynamicQuery(
73          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
74          int end) throws com.liferay.portal.SystemException;
75  
76      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
77      public com.liferay.portal.model.Role getRole(long roleId)
78          throws com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public java.util.List<com.liferay.portal.model.Role> getRoles(int start,
83          int end) throws com.liferay.portal.SystemException;
84  
85      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
86      public int getRolesCount() throws com.liferay.portal.SystemException;
87  
88      public com.liferay.portal.model.Role updateRole(
89          com.liferay.portal.model.Role role)
90          throws com.liferay.portal.SystemException;
91  
92      public com.liferay.portal.model.Role updateRole(
93          com.liferay.portal.model.Role role, boolean merge)
94          throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Role addRole(long userId, long companyId,
97          java.lang.String name, java.lang.String description, int type)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portal.model.Role addRole(long userId, long companyId,
102         java.lang.String name, java.lang.String description, int type,
103         java.lang.String className, long classPK)
104         throws com.liferay.portal.PortalException,
105             com.liferay.portal.SystemException;
106 
107     public void addUserRoles(long userId, long[] roleIds)
108         throws com.liferay.portal.SystemException;
109 
110     public void checkSystemRoles(long companyId)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115     public com.liferay.portal.model.Role getGroupRole(long companyId,
116         long groupId)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121     public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
122         long groupId) throws com.liferay.portal.SystemException;
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public java.util.Map<String, java.util.List<String>> getResourceRoles(
126         long companyId, java.lang.String name, int scope,
127         java.lang.String primKey) throws com.liferay.portal.SystemException;
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public com.liferay.portal.model.Role getRole(long companyId,
131         java.lang.String name)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136     public java.util.List<com.liferay.portal.model.Role> getRoles(
137         long companyId) throws com.liferay.portal.SystemException;
138 
139     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140     public java.util.List<com.liferay.portal.model.Role> getRoles(
141         long[] roleIds)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException;
144 
145     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146     public java.util.List<com.liferay.portal.model.Role> getRoles(int type,
147         java.lang.String subtype) throws com.liferay.portal.SystemException;
148 
149     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150     public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
151         long userId, long groupId) throws com.liferay.portal.SystemException;
152 
153     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
155         long userId, long groupId) throws com.liferay.portal.SystemException;
156 
157     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
159         long userId, long[] groupIds) throws com.liferay.portal.SystemException;
160 
161     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
163         long userId, java.util.List<com.liferay.portal.model.Group> groups)
164         throws com.liferay.portal.SystemException;
165 
166     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167     public java.util.List<com.liferay.portal.model.Role> getUserRoles(
168         long userId) throws com.liferay.portal.SystemException;
169 
170     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171     public boolean hasUserRole(long userId, long roleId)
172         throws com.liferay.portal.SystemException;
173 
174     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175     public boolean hasUserRole(long userId, long companyId,
176         java.lang.String name, boolean inherited)
177         throws com.liferay.portal.PortalException,
178             com.liferay.portal.SystemException;
179 
180     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181     public boolean hasUserRoles(long userId, long companyId,
182         java.lang.String[] names, boolean inherited)
183         throws com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187     public java.util.List<com.liferay.portal.model.Role> search(
188         long companyId, java.lang.String name, java.lang.String description,
189         java.lang.Integer type, int start, int end,
190         com.liferay.portal.kernel.util.OrderByComparator obc)
191         throws com.liferay.portal.SystemException;
192 
193     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194     public java.util.List<com.liferay.portal.model.Role> search(
195         long companyId, java.lang.String name, java.lang.String description,
196         java.lang.Integer type, java.util.LinkedHashMap<String, Object> params,
197         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
198         throws com.liferay.portal.SystemException;
199 
200     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201     public int searchCount(long companyId, java.lang.String name,
202         java.lang.String description, java.lang.Integer type)
203         throws com.liferay.portal.SystemException;
204 
205     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206     public int searchCount(long companyId, java.lang.String name,
207         java.lang.String description, java.lang.Integer type,
208         java.util.LinkedHashMap<String, Object> params)
209         throws com.liferay.portal.SystemException;
210 
211     public void setUserRoles(long userId, long[] roleIds)
212         throws com.liferay.portal.PortalException,
213             com.liferay.portal.SystemException;
214 
215     public void unsetUserRoles(long userId, long[] roleIds)
216         throws com.liferay.portal.PortalException,
217             com.liferay.portal.SystemException;
218 
219     public com.liferay.portal.model.Role updateRole(long roleId,
220         java.lang.String name,
221         java.util.Map<java.util.Locale, String> localeTitlesMap,
222         java.lang.String description, java.lang.String subtype)
223         throws com.liferay.portal.PortalException,
224             com.liferay.portal.SystemException;
225 }