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="GroupService.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.GroupServiceImpl</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.GroupServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface GroupService {
55      public com.liferay.portal.model.Group addGroup(java.lang.String name,
56          java.lang.String description, int type, java.lang.String friendlyURL,
57          boolean active, com.liferay.portal.service.ServiceContext serviceContext)
58          throws com.liferay.portal.PortalException,
59              com.liferay.portal.SystemException;
60  
61      public com.liferay.portal.model.Group addGroup(long liveGroupId,
62          java.lang.String name, java.lang.String description, int type,
63          java.lang.String friendlyURL, boolean active,
64          com.liferay.portal.service.ServiceContext serviceContext)
65          throws com.liferay.portal.PortalException,
66              com.liferay.portal.SystemException;
67  
68      public void addRoleGroups(long roleId, long[] groupIds)
69          throws com.liferay.portal.PortalException,
70              com.liferay.portal.SystemException;
71  
72      public void deleteGroup(long groupId)
73          throws com.liferay.portal.PortalException,
74              com.liferay.portal.SystemException;
75  
76      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
77      public com.liferay.portal.model.Group getGroup(long groupId)
78          throws com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public com.liferay.portal.model.Group getGroup(long companyId,
83          java.lang.String name)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public java.util.List<com.liferay.portal.model.Group> getManageableGroups(
89          java.lang.String actionId, int max)
90          throws com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException;
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
95          java.util.List<com.liferay.portal.model.Organization> organizations);
96  
97      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
98      public com.liferay.portal.model.Group getUserGroup(long companyId,
99          long userId)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException;
102 
103     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104     public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
105         java.util.List<com.liferay.portal.model.UserGroup> userGroups);
106 
107     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
108     public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(
109         long userId, int start, int end)
110         throws com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException;
112 
113     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
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         com.liferay.portal.service.ServiceContext serviceContext)
145         throws com.liferay.portal.PortalException,
146             com.liferay.portal.SystemException;
147 
148     public com.liferay.portal.model.Group updateGroup(long groupId,
149         java.lang.String typeSettings)
150         throws com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public com.liferay.portal.model.Group updateWorkflow(long groupId,
154         boolean workflowEnabled, int workflowStages,
155         java.lang.String workflowRoleNames)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException;
158 }