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.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="RoleService.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This interface defines the service. The default implementation is
37   * <code>com.liferay.portal.service.impl.RoleServiceImpl</code>.
38   * Modify methods in that class and rerun ServiceBuilder to populate this class
39   * and all other generated classes.
40   * </p>
41   *
42   * <p>
43   * 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.
44   * </p>
45   *
46   * @author Brian Wing Shun Chan
47   *
48   * @see com.liferay.portal.service.RoleServiceUtil
49   *
50   */
51  @Transactional(rollbackFor =  {
52      PortalException.class, SystemException.class})
53  public interface RoleService {
54      public com.liferay.portal.model.Role addRole(java.lang.String name,
55          java.lang.String description, int type)
56          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
57              com.liferay.portal.SystemException;
58  
59      public void addUserRoles(long userId, long[] roleIds)
60          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
61              com.liferay.portal.SystemException;
62  
63      public void deleteRole(long roleId)
64          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
65              com.liferay.portal.SystemException;
66  
67      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
68      public com.liferay.portal.model.Role getGroupRole(long companyId,
69          long groupId)
70          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
71              com.liferay.portal.SystemException;
72  
73      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
74      public java.util.List<com.liferay.portal.model.Role> getGroupRoles(
75          long groupId)
76          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portal.model.Role getRole(long roleId)
80          throws java.rmi.RemoteException, 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 java.rmi.RemoteException, 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)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
93  
94      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
95      public java.util.List<com.liferay.portal.model.Role> getUserRelatedRoles(
96          long userId, java.util.List<com.liferay.portal.model.Group> groups)
97          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
98  
99      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100     public java.util.List<com.liferay.portal.model.Role> getUserRoles(
101         long userId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
103 
104     public boolean hasUserRole(long userId, long companyId,
105         java.lang.String name, boolean inherited)
106         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public boolean hasUserRoles(long userId, long companyId,
110         java.lang.String[] names, boolean inherited)
111         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public void unsetUserRoles(long userId, long[] roleIds)
115         throws java.rmi.RemoteException, 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, java.lang.String description)
120         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException;
122 }