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="GroupLocalService.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 interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.GroupLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.GroupLocalServiceFactory
48   * @see com.liferay.portal.service.GroupLocalServiceUtil
49   *
50   */
51  public interface GroupLocalService {
52      public com.liferay.portal.model.Group addGroup(
53          com.liferay.portal.model.Group group)
54          throws com.liferay.portal.SystemException;
55  
56      public void deleteGroup(long groupId)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deleteGroup(com.liferay.portal.model.Group group)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public java.util.List<com.liferay.portal.model.Group> dynamicQuery(
65          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<com.liferay.portal.model.Group> dynamicQuery(
69          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
70          int begin, int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Group updateGroup(
73          com.liferay.portal.model.Group group)
74          throws com.liferay.portal.SystemException;
75  
76      public com.liferay.portal.model.Group addGroup(long userId,
77          java.lang.String className, long classPK, java.lang.String name,
78          java.lang.String description, int type, java.lang.String friendlyURL,
79          boolean active)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      public com.liferay.portal.model.Group addGroup(long userId,
84          java.lang.String className, long classPK, long liveGroupId,
85          java.lang.String name, java.lang.String description, int type,
86          java.lang.String friendlyURL, boolean active)
87          throws com.liferay.portal.SystemException,
88              com.liferay.portal.PortalException;
89  
90      public void addRoleGroups(long roleId, long[] groupIds)
91          throws com.liferay.portal.SystemException,
92              com.liferay.portal.PortalException;
93  
94      public void addUserGroups(long userId, long[] groupIds)
95          throws com.liferay.portal.SystemException,
96              com.liferay.portal.PortalException;
97  
98      public void checkSystemGroups(long companyId)
99          throws com.liferay.portal.SystemException,
100             com.liferay.portal.PortalException;
101 
102     public com.liferay.portal.model.Group getFriendlyURLGroup(long companyId,
103         java.lang.String friendlyURL)
104         throws com.liferay.portal.SystemException,
105             com.liferay.portal.PortalException;
106 
107     public com.liferay.portal.model.Group getGroup(long groupId)
108         throws com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException;
110 
111     public com.liferay.portal.model.Group getGroup(long companyId,
112         java.lang.String name)
113         throws com.liferay.portal.SystemException,
114             com.liferay.portal.PortalException;
115 
116     public java.util.List<com.liferay.portal.model.Group> getNullFriendlyURLGroups()
117         throws com.liferay.portal.SystemException;
118 
119     public com.liferay.portal.model.Group getOrganizationGroup(long companyId,
120         long organizationId)
121         throws com.liferay.portal.SystemException,
122             com.liferay.portal.PortalException;
123 
124     public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
125         java.util.List<com.liferay.portal.model.Organization> organizations)
126         throws com.liferay.portal.SystemException,
127             com.liferay.portal.PortalException;
128 
129     public java.util.List<com.liferay.portal.model.Group> getRoleGroups(
130         long roleId)
131         throws com.liferay.portal.SystemException,
132             com.liferay.portal.PortalException;
133 
134     public com.liferay.portal.model.Group getStagingGroup(long liveGroupId)
135         throws com.liferay.portal.SystemException,
136             com.liferay.portal.PortalException;
137 
138     public com.liferay.portal.model.Group getUserGroup(long companyId,
139         long userId)
140         throws com.liferay.portal.SystemException,
141             com.liferay.portal.PortalException;
142 
143     public com.liferay.portal.model.Group getUserGroupGroup(long companyId,
144         long userGroupId)
145         throws com.liferay.portal.SystemException,
146             com.liferay.portal.PortalException;
147 
148     public java.util.List<com.liferay.portal.model.Group> getUserGroups(
149         long userId)
150         throws com.liferay.portal.SystemException,
151             com.liferay.portal.PortalException;
152 
153     public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
154         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
155         throws com.liferay.portal.SystemException,
156             com.liferay.portal.PortalException;
157 
158     public boolean hasRoleGroup(long roleId, long groupId)
159         throws com.liferay.portal.SystemException,
160             com.liferay.portal.PortalException;
161 
162     public boolean hasUserGroup(long userId, long groupId)
163         throws com.liferay.portal.SystemException;
164 
165     public java.util.List<com.liferay.portal.model.Group> search(
166         long companyId, java.lang.String name, java.lang.String description,
167         java.util.LinkedHashMap<String, Object> params, int begin, int end)
168         throws com.liferay.portal.SystemException;
169 
170     public java.util.List<com.liferay.portal.model.Group> search(
171         long companyId, java.lang.String name, java.lang.String description,
172         java.util.LinkedHashMap<String, Object> params, int begin, int end,
173         com.liferay.portal.kernel.util.OrderByComparator obc)
174         throws com.liferay.portal.SystemException;
175 
176     public int searchCount(long companyId, java.lang.String name,
177         java.lang.String description,
178         java.util.LinkedHashMap<String, Object> params)
179         throws com.liferay.portal.SystemException;
180 
181     public void setRoleGroups(long roleId, long[] groupIds)
182         throws com.liferay.portal.SystemException,
183             com.liferay.portal.PortalException;
184 
185     public void unsetRoleGroups(long roleId, long[] groupIds)
186         throws com.liferay.portal.SystemException,
187             com.liferay.portal.PortalException;
188 
189     public void unsetUserGroups(long userId, long[] groupIds)
190         throws com.liferay.portal.SystemException,
191             com.liferay.portal.PortalException;
192 
193     public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
194         java.lang.String friendlyURL)
195         throws com.liferay.portal.SystemException,
196             com.liferay.portal.PortalException;
197 
198     public com.liferay.portal.model.Group updateGroup(long groupId,
199         java.lang.String name, java.lang.String description, int type,
200         java.lang.String friendlyURL, boolean active)
201         throws com.liferay.portal.SystemException,
202             com.liferay.portal.PortalException;
203 
204     public com.liferay.portal.model.Group updateGroup(long groupId,
205         java.lang.String typeSettings)
206         throws com.liferay.portal.SystemException,
207             com.liferay.portal.PortalException;
208 
209     public com.liferay.portal.model.Group updateWorkflow(long groupId,
210         boolean workflowEnabled, int workflowStages,
211         java.lang.String workflowRoleNames)
212         throws com.liferay.portal.SystemException,
213             com.liferay.portal.PortalException;
214 }