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