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="RoleServiceUtil.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 class provides static methods for the
36   * <code>com.liferay.portal.service.RoleService</code>
37   * bean. The static methods of this class calls the same methods of the bean
38   * instance. It's convenient to be able to just write one line to call a method
39   * on a bean instead of writing a lookup call and a method call.
40   * </p>
41   *
42   * <p>
43   * <code>com.liferay.portal.service.RoleServiceFactory</code>
44   * is responsible for the lookup of the bean.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.RoleService
50   * @see com.liferay.portal.service.RoleServiceFactory
51   *
52   */
53  public class RoleServiceUtil {
54      public static com.liferay.portal.model.Role addRole(java.lang.String name,
55          java.lang.String description, int type)
56          throws com.liferay.portal.PortalException,
57              com.liferay.portal.SystemException, java.rmi.RemoteException {
58          RoleService roleService = RoleServiceFactory.getService();
59  
60          return roleService.addRole(name, description, type);
61      }
62  
63      public static void addUserRoles(long userId, long[] roleIds)
64          throws com.liferay.portal.PortalException,
65              com.liferay.portal.SystemException, java.rmi.RemoteException {
66          RoleService roleService = RoleServiceFactory.getService();
67  
68          roleService.addUserRoles(userId, roleIds);
69      }
70  
71      public static void deleteRole(long roleId)
72          throws com.liferay.portal.PortalException,
73              com.liferay.portal.SystemException, java.rmi.RemoteException {
74          RoleService roleService = RoleServiceFactory.getService();
75  
76          roleService.deleteRole(roleId);
77      }
78  
79      public static com.liferay.portal.model.Role getGroupRole(long companyId,
80          long groupId)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException, java.rmi.RemoteException {
83          RoleService roleService = RoleServiceFactory.getService();
84  
85          return roleService.getGroupRole(companyId, groupId);
86      }
87  
88      public static java.util.List<com.liferay.portal.model.Role> getGroupRoles(
89          long groupId)
90          throws com.liferay.portal.SystemException, java.rmi.RemoteException {
91          RoleService roleService = RoleServiceFactory.getService();
92  
93          return roleService.getGroupRoles(groupId);
94      }
95  
96      public static com.liferay.portal.model.Role getRole(long roleId)
97          throws com.liferay.portal.PortalException,
98              com.liferay.portal.SystemException, java.rmi.RemoteException {
99          RoleService roleService = RoleServiceFactory.getService();
100 
101         return roleService.getRole(roleId);
102     }
103 
104     public static com.liferay.portal.model.Role getRole(long companyId,
105         java.lang.String name)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException, java.rmi.RemoteException {
108         RoleService roleService = RoleServiceFactory.getService();
109 
110         return roleService.getRole(companyId, name);
111     }
112 
113     public static java.util.List<com.liferay.portal.model.Role> getUserGroupRoles(
114         long userId, long groupId)
115         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
116         RoleService roleService = RoleServiceFactory.getService();
117 
118         return roleService.getUserGroupRoles(userId, groupId);
119     }
120 
121     public static java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
122         long userId, java.util.List<com.liferay.portal.model.Group> groups)
123         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
124         RoleService roleService = RoleServiceFactory.getService();
125 
126         return roleService.getUserRelatedRoles(userId, groups);
127     }
128 
129     public static java.util.List<com.liferay.portal.model.Role> getUserRoles(
130         long userId)
131         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
132         RoleService roleService = RoleServiceFactory.getService();
133 
134         return roleService.getUserRoles(userId);
135     }
136 
137     public static boolean hasUserRole(long userId, long companyId,
138         java.lang.String name, boolean inherited)
139         throws com.liferay.portal.PortalException,
140             com.liferay.portal.SystemException, java.rmi.RemoteException {
141         RoleService roleService = RoleServiceFactory.getService();
142 
143         return roleService.hasUserRole(userId, companyId, name, inherited);
144     }
145 
146     public static boolean hasUserRoles(long userId, long companyId,
147         java.lang.String[] names, boolean inherited)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException, java.rmi.RemoteException {
150         RoleService roleService = RoleServiceFactory.getService();
151 
152         return roleService.hasUserRoles(userId, companyId, names, inherited);
153     }
154 
155     public static void unsetUserRoles(long userId, long[] roleIds)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException, java.rmi.RemoteException {
158         RoleService roleService = RoleServiceFactory.getService();
159 
160         roleService.unsetUserRoles(userId, roleIds);
161     }
162 
163     public static com.liferay.portal.model.Role updateRole(long roleId,
164         java.lang.String name, java.lang.String description)
165         throws com.liferay.portal.PortalException,
166             com.liferay.portal.SystemException, java.rmi.RemoteException {
167         RoleService roleService = RoleServiceFactory.getService();
168 
169         return roleService.updateRole(roleId, name, description);
170     }
171 }