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.RoleLocalServiceFactory
48   * @see com.liferay.portal.service.RoleLocalServiceUtil
49   *
50   */
51  public interface RoleLocalService {
52      public com.liferay.portal.model.Role addRole(
53          com.liferay.portal.model.Role role)
54          throws com.liferay.portal.SystemException;
55  
56      public void deleteRole(long roleId)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deleteRole(com.liferay.portal.model.Role role)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public java.util.List<com.liferay.portal.model.Role> dynamicQuery(
65          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<com.liferay.portal.model.Role> dynamicQuery(
69          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
70          int begin, int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Role updateRole(
73          com.liferay.portal.model.Role role)
74          throws com.liferay.portal.SystemException;
75  
76      public com.liferay.portal.model.Role addRole(long userId, long companyId,
77          java.lang.String name, java.lang.String description, int type)
78          throws com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException;
80  
81      public com.liferay.portal.model.Role addRole(long userId, long companyId,
82          java.lang.String name, java.lang.String description, int type,
83          java.lang.String className, long classPK)
84          throws com.liferay.portal.SystemException,
85              com.liferay.portal.PortalException;
86  
87      public void addUserRoles(long userId, long[] roleIds)
88          throws com.liferay.portal.SystemException,
89              com.liferay.portal.PortalException;
90  
91      public void checkSystemRoles(long companyId)
92          throws com.liferay.portal.SystemException,
93              com.liferay.portal.PortalException;
94  
95      public com.liferay.portal.model.Role getGroupRole(long companyId,
96          long groupId)
97          throws com.liferay.portal.SystemException,
98              com.liferay.portal.PortalException;
99  
100     public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
101         long groupId)
102         throws com.liferay.portal.SystemException,
103             com.liferay.portal.PortalException;
104 
105     public java.util.Map<String, java.util.List<String>> getResourceRoles(
106         long companyId, java.lang.String name, int scope,
107         java.lang.String primKey) throws com.liferay.portal.SystemException;
108 
109     public com.liferay.portal.model.Role getRole(long roleId)
110         throws com.liferay.portal.SystemException,
111             com.liferay.portal.PortalException;
112 
113     public com.liferay.portal.model.Role getRole(long companyId,
114         java.lang.String name)
115         throws com.liferay.portal.SystemException,
116             com.liferay.portal.PortalException;
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)
136         throws com.liferay.portal.SystemException,
137             com.liferay.portal.PortalException;
138 
139     public boolean hasUserRole(long userId, long roleId)
140         throws com.liferay.portal.SystemException,
141             com.liferay.portal.PortalException;
142 
143     public boolean hasUserRole(long userId, long companyId,
144         java.lang.String name, boolean inherited)
145         throws com.liferay.portal.SystemException,
146             com.liferay.portal.PortalException;
147 
148     public boolean hasUserRoles(long userId, long companyId,
149         java.lang.String[] names, boolean inherited)
150         throws com.liferay.portal.SystemException,
151             com.liferay.portal.PortalException;
152 
153     public java.util.List<com.liferay.portal.model.Role> search(
154         long companyId, java.lang.String name, java.lang.String description,
155         java.lang.Integer type, int begin, int end,
156         com.liferay.portal.kernel.util.OrderByComparator obc)
157         throws com.liferay.portal.SystemException;
158 
159     public java.util.List<com.liferay.portal.model.Role> search(
160         long companyId, java.lang.String name, java.lang.String description,
161         java.lang.Integer type, java.util.LinkedHashMap<String, Object> params,
162         int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
163         throws com.liferay.portal.SystemException;
164 
165     public int searchCount(long companyId, java.lang.String name,
166         java.lang.String description, java.lang.Integer type)
167         throws com.liferay.portal.SystemException;
168 
169     public int searchCount(long companyId, java.lang.String name,
170         java.lang.String description, java.lang.Integer type,
171         java.util.LinkedHashMap<String, Object> params)
172         throws com.liferay.portal.SystemException;
173 
174     public void setUserRoles(long userId, long[] roleIds)
175         throws com.liferay.portal.SystemException,
176             com.liferay.portal.PortalException;
177 
178     public void unsetUserRoles(long userId, long[] roleIds)
179         throws com.liferay.portal.SystemException,
180             com.liferay.portal.PortalException;
181 
182     public com.liferay.portal.model.Role updateRole(long roleId,
183         java.lang.String name, java.lang.String description)
184         throws com.liferay.portal.SystemException,
185             com.liferay.portal.PortalException;
186 }