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