1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Isolation;
25  import com.liferay.portal.kernel.annotation.Propagation;
26  import com.liferay.portal.kernel.annotation.Transactional;
27  
28  /**
29   * <a href="RoleService.java.html"><b><i>View Source</i></b></a>
30   *
31   * <p>
32   * ServiceBuilder generated this class. Modifications in this class will be
33   * overwritten the next time is generated.
34   * </p>
35   *
36   * <p>
37   * This interface defines the service. The default implementation is
38   * <code>com.liferay.portal.service.impl.RoleServiceImpl</code>.
39   * Modify methods in that class and rerun ServiceBuilder to populate this class
40   * and all other generated classes.
41   * </p>
42   *
43   * <p>
44   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.RoleServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface RoleService {
55      public com.liferay.portal.model.Role addRole(java.lang.String name,
56          java.lang.String description, int type)
57          throws com.liferay.portal.PortalException,
58              com.liferay.portal.SystemException;
59  
60      public void addUserRoles(long userId, long[] roleIds)
61          throws com.liferay.portal.PortalException,
62              com.liferay.portal.SystemException;
63  
64      public void deleteRole(long roleId)
65          throws com.liferay.portal.PortalException,
66              com.liferay.portal.SystemException;
67  
68      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
69      public com.liferay.portal.model.Role getGroupRole(long companyId,
70          long groupId)
71          throws com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
75      public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
76          long groupId) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portal.model.Role getRole(long roleId)
80          throws com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public com.liferay.portal.model.Role getRole(long companyId,
85          java.lang.String name)
86          throws com.liferay.portal.PortalException,
87              com.liferay.portal.SystemException;
88  
89      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
90      public java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
91          long userId, long groupId) throws com.liferay.portal.SystemException;
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
95          long userId, java.util.List<com.liferay.portal.model.Group> groups)
96          throws com.liferay.portal.SystemException;
97  
98      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
99      public java.util.List<com.liferay.portal.model.Role> getUserRoles(
100         long userId) throws com.liferay.portal.SystemException;
101 
102     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
103     public boolean hasUserRole(long userId, long companyId,
104         java.lang.String name, boolean inherited)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public boolean hasUserRoles(long userId, long companyId,
110         java.lang.String[] names, boolean inherited)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public void unsetUserRoles(long userId, long[] roleIds)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public com.liferay.portal.model.Role updateRole(long roleId,
119         java.lang.String name,
120         java.util.Map<java.util.Locale, String> localeTitlesMap,
121         java.lang.String description, java.lang.String subtype)
122         throws com.liferay.portal.PortalException,
123             com.liferay.portal.SystemException;
124 }