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