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  
26  /**
27   * <a href="RoleLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.RoleLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.RoleLocalServiceUtil
48   *
49   */
50  public interface RoleLocalService {
51      public com.liferay.portal.model.Role addRole(
52          com.liferay.portal.model.Role role)
53          throws com.liferay.portal.SystemException;
54  
55      public void deleteRole(long roleId)
56          throws com.liferay.portal.SystemException,
57              com.liferay.portal.PortalException;
58  
59      public void deleteRole(com.liferay.portal.model.Role role)
60          throws com.liferay.portal.SystemException;
61  
62      public java.util.List<Object> dynamicQuery(
63          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
64          throws com.liferay.portal.SystemException;
65  
66      public java.util.List<Object> dynamicQuery(
67          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
68          int end) throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Role getRole(long roleId)
71          throws com.liferay.portal.SystemException,
72              com.liferay.portal.PortalException;
73  
74      public java.util.List<com.liferay.portal.model.Role> getRoles(int start,
75          int end) throws com.liferay.portal.SystemException;
76  
77      public int getRolesCount() throws com.liferay.portal.SystemException;
78  
79      public com.liferay.portal.model.Role updateRole(
80          com.liferay.portal.model.Role role)
81          throws com.liferay.portal.SystemException;
82  
83      public com.liferay.portal.model.Role addRole(long userId, long companyId,
84          java.lang.String name, java.lang.String description, int type)
85          throws com.liferay.portal.PortalException,
86              com.liferay.portal.SystemException;
87  
88      public com.liferay.portal.model.Role addRole(long userId, long companyId,
89          java.lang.String name, java.lang.String description, int type,
90          java.lang.String className, long classPK)
91          throws com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException;
93  
94      public void addUserRoles(long userId, long[] roleIds)
95          throws com.liferay.portal.SystemException;
96  
97      public void checkSystemRoles(long companyId)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portal.model.Role getGroupRole(long companyId,
102         long groupId)
103         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException;
105 
106     public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
107         long groupId) throws com.liferay.portal.SystemException;
108 
109     public java.util.Map<String, java.util.List<String>> getResourceRoles(
110         long companyId, java.lang.String name, int scope,
111         java.lang.String primKey) throws com.liferay.portal.SystemException;
112 
113     public com.liferay.portal.model.Role getRole(long companyId,
114         java.lang.String name)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public java.util.List<com.liferay.portal.model.Role> getRoles(
119         long companyId) throws com.liferay.portal.SystemException;
120 
121     public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
122         long userId, long groupId) throws com.liferay.portal.SystemException;
123 
124     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
125         long userId, long groupId) throws com.liferay.portal.SystemException;
126 
127     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
128         long userId, long[] groupIds) throws com.liferay.portal.SystemException;
129 
130     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
131         long userId, java.util.List<com.liferay.portal.model.Group> groups)
132         throws com.liferay.portal.SystemException;
133 
134     public java.util.List<com.liferay.portal.model.Role> getUserRoles(
135         long userId) throws com.liferay.portal.SystemException;
136 
137     public boolean hasUserRole(long userId, long roleId)
138         throws com.liferay.portal.SystemException;
139 
140     public boolean hasUserRole(long userId, long companyId,
141         java.lang.String name, boolean inherited)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException;
144 
145     public boolean hasUserRoles(long userId, long companyId,
146         java.lang.String[] names, boolean inherited)
147         throws com.liferay.portal.PortalException,
148             com.liferay.portal.SystemException;
149 
150     public java.util.List<com.liferay.portal.model.Role> search(
151         long companyId, java.lang.String name, java.lang.String description,
152         java.lang.Integer type, int start, int end,
153         com.liferay.portal.kernel.util.OrderByComparator obc)
154         throws com.liferay.portal.SystemException;
155 
156     public java.util.List<com.liferay.portal.model.Role> search(
157         long companyId, java.lang.String name, java.lang.String description,
158         java.lang.Integer type, java.util.LinkedHashMap<String, Object> params,
159         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
160         throws com.liferay.portal.SystemException;
161 
162     public int searchCount(long companyId, java.lang.String name,
163         java.lang.String description, java.lang.Integer type)
164         throws com.liferay.portal.SystemException;
165 
166     public int searchCount(long companyId, java.lang.String name,
167         java.lang.String description, java.lang.Integer type,
168         java.util.LinkedHashMap<String, Object> params)
169         throws com.liferay.portal.SystemException;
170 
171     public void setUserRoles(long userId, long[] roleIds)
172         throws com.liferay.portal.SystemException;
173 
174     public void unsetUserRoles(long userId, long[] roleIds)
175         throws com.liferay.portal.SystemException;
176 
177     public com.liferay.portal.model.Role updateRole(long roleId,
178         java.lang.String name, java.lang.String description)
179         throws com.liferay.portal.PortalException,
180             com.liferay.portal.SystemException;
181 }