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 com.liferay.portal.model.Role createRole(long roleId);
56  
57      public void deleteRole(long roleId)
58          throws com.liferay.portal.SystemException,
59              com.liferay.portal.PortalException;
60  
61      public void deleteRole(com.liferay.portal.model.Role role)
62          throws com.liferay.portal.SystemException;
63  
64      public java.util.List<Object> dynamicQuery(
65          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<Object> dynamicQuery(
69          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
70          int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Role getRole(long roleId)
73          throws com.liferay.portal.SystemException,
74              com.liferay.portal.PortalException;
75  
76      public java.util.List<com.liferay.portal.model.Role> getRoles(int start,
77          int end) throws com.liferay.portal.SystemException;
78  
79      public int getRolesCount() throws com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.Role updateRole(
82          com.liferay.portal.model.Role role)
83          throws com.liferay.portal.SystemException;
84  
85      public com.liferay.portal.model.Role addRole(long userId, long companyId,
86          java.lang.String name, java.lang.String description, int type)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Role addRole(long userId, long companyId,
91          java.lang.String name, java.lang.String description, int type,
92          java.lang.String className, long classPK)
93          throws com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException;
95  
96      public void addUserRoles(long userId, long[] roleIds)
97          throws com.liferay.portal.SystemException;
98  
99      public void checkSystemRoles(long companyId)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException;
102 
103     public com.liferay.portal.model.Role getGroupRole(long companyId,
104         long groupId)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
109         long groupId) throws com.liferay.portal.SystemException;
110 
111     public java.util.Map<String, java.util.List<String>> getResourceRoles(
112         long companyId, java.lang.String name, int scope,
113         java.lang.String primKey) throws com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Role getRole(long companyId,
116         java.lang.String name)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     public java.util.List<com.liferay.portal.model.Role> getRoles(
121         long companyId) throws com.liferay.portal.SystemException;
122 
123     public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
124         long userId, long groupId) throws com.liferay.portal.SystemException;
125 
126     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
127         long userId, long groupId) throws com.liferay.portal.SystemException;
128 
129     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
130         long userId, long[] groupIds) throws com.liferay.portal.SystemException;
131 
132     public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
133         long userId, java.util.List<com.liferay.portal.model.Group> groups)
134         throws com.liferay.portal.SystemException;
135 
136     public java.util.List<com.liferay.portal.model.Role> getUserRoles(
137         long userId) throws com.liferay.portal.SystemException;
138 
139     public boolean hasUserRole(long userId, long roleId)
140         throws com.liferay.portal.SystemException;
141 
142     public boolean hasUserRole(long userId, long companyId,
143         java.lang.String name, boolean inherited)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 
147     public boolean hasUserRoles(long userId, long companyId,
148         java.lang.String[] names, boolean inherited)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException;
151 
152     public java.util.List<com.liferay.portal.model.Role> search(
153         long companyId, java.lang.String name, java.lang.String description,
154         java.lang.Integer type, int start, int end,
155         com.liferay.portal.kernel.util.OrderByComparator obc)
156         throws com.liferay.portal.SystemException;
157 
158     public java.util.List<com.liferay.portal.model.Role> search(
159         long companyId, java.lang.String name, java.lang.String description,
160         java.lang.Integer type, java.util.LinkedHashMap<String, Object> params,
161         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
162         throws com.liferay.portal.SystemException;
163 
164     public int searchCount(long companyId, java.lang.String name,
165         java.lang.String description, java.lang.Integer type)
166         throws com.liferay.portal.SystemException;
167 
168     public int searchCount(long companyId, java.lang.String name,
169         java.lang.String description, java.lang.Integer type,
170         java.util.LinkedHashMap<String, Object> params)
171         throws com.liferay.portal.SystemException;
172 
173     public void setUserRoles(long userId, long[] roleIds)
174         throws com.liferay.portal.SystemException;
175 
176     public void unsetUserRoles(long userId, long[] roleIds)
177         throws com.liferay.portal.SystemException;
178 
179     public com.liferay.portal.model.Role updateRole(long roleId,
180         java.lang.String name, java.lang.String description)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException;
183 }