1   /**
2    * Copyright (c) 2000-2009 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  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="GroupService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portal.service.impl.GroupServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * 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.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portal.service.GroupServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface GroupService {
57      public com.liferay.portal.model.Group addGroup(java.lang.String name,
58          java.lang.String description, int type, java.lang.String friendlyURL,
59          boolean active)
60          throws com.liferay.portal.PortalException,
61              com.liferay.portal.SystemException;
62  
63      public com.liferay.portal.model.Group addGroup(long liveGroupId,
64          java.lang.String name, java.lang.String description, int type,
65          java.lang.String friendlyURL, boolean active)
66          throws com.liferay.portal.PortalException,
67              com.liferay.portal.SystemException;
68  
69      public void addRoleGroups(long roleId, long[] groupIds)
70          throws com.liferay.portal.PortalException,
71              com.liferay.portal.SystemException;
72  
73      public void deleteGroup(long groupId)
74          throws com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException;
76  
77      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
78      public com.liferay.portal.model.Group getGroup(long groupId)
79          throws com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException;
81  
82      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
83      public com.liferay.portal.model.Group getGroup(long companyId,
84          java.lang.String name)
85          throws com.liferay.portal.PortalException,
86              com.liferay.portal.SystemException;
87  
88      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
89      public java.util.List<com.liferay.portal.model.Group> getManageableGroups(
90          long userId, java.lang.String actionId)
91          throws com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException;
93  
94      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
95      public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
96          java.util.List<com.liferay.portal.model.Organization> organizations);
97  
98      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
99      public com.liferay.portal.model.Group getUserGroup(long companyId,
100         long userId)
101         throws com.liferay.portal.PortalException,
102             com.liferay.portal.SystemException;
103 
104     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
105     public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
106         java.util.List<com.liferay.portal.model.UserGroup> userGroups);
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(
110         long userId, int start, int end)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public boolean hasUserGroup(long userId, long groupId)
115         throws com.liferay.portal.SystemException;
116 
117     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118     public java.util.List<com.liferay.portal.model.Group> search(
119         long companyId, java.lang.String name, java.lang.String description,
120         java.lang.String[] params, int start, int end)
121         throws com.liferay.portal.SystemException;
122 
123     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
124     public int searchCount(long companyId, java.lang.String name,
125         java.lang.String description, java.lang.String[] params)
126         throws com.liferay.portal.SystemException;
127 
128     public void setRoleGroups(long roleId, long[] groupIds)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException;
131 
132     public void unsetRoleGroups(long roleId, long[] groupIds)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
137         java.lang.String friendlyURL)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public com.liferay.portal.model.Group updateGroup(long groupId,
142         java.lang.String name, java.lang.String description, int type,
143         java.lang.String friendlyURL, boolean active)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 
147     public com.liferay.portal.model.Group updateGroup(long groupId,
148         java.lang.String typeSettings)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException;
151 
152     public com.liferay.portal.model.Group updateWorkflow(long groupId,
153         boolean workflowEnabled, int workflowStages,
154         java.lang.String workflowRoleNames)
155         throws com.liferay.portal.PortalException,
156             com.liferay.portal.SystemException;
157 }