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.GroupLocalServiceUtil
48   *
49   */
50  public interface GroupLocalService {
51      public com.liferay.portal.model.Group addGroup(
52          com.liferay.portal.model.Group group)
53          throws com.liferay.portal.SystemException;
54  
55      public com.liferay.portal.model.Group createGroup(long groupId);
56  
57      public void deleteGroup(long groupId)
58          throws com.liferay.portal.SystemException,
59              com.liferay.portal.PortalException;
60  
61      public void deleteGroup(com.liferay.portal.model.Group group)
62          throws com.liferay.portal.SystemException;
63  
64      public java.util.List<Object> dynamicQuery(
65          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<Object> dynamicQuery(
69          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
70          int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Group getGroup(long groupId)
73          throws com.liferay.portal.SystemException,
74              com.liferay.portal.PortalException;
75  
76      public java.util.List<com.liferay.portal.model.Group> getGroups(int start,
77          int end) throws com.liferay.portal.SystemException;
78  
79      public int getGroupsCount() throws com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.Group updateGroup(
82          com.liferay.portal.model.Group group)
83          throws com.liferay.portal.SystemException;
84  
85      public com.liferay.portal.model.Group addGroup(long userId,
86          java.lang.String className, long classPK, java.lang.String name,
87          java.lang.String description, int type, java.lang.String friendlyURL,
88          boolean active)
89          throws com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      public com.liferay.portal.model.Group addGroup(long userId,
93          java.lang.String className, long classPK, long liveGroupId,
94          java.lang.String name, java.lang.String description, int type,
95          java.lang.String friendlyURL, boolean active)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public void addRoleGroups(long roleId, long[] groupIds)
100         throws com.liferay.portal.SystemException;
101 
102     public void addUserGroups(long userId, long[] groupIds)
103         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException;
105 
106     public void checkSystemGroups(long companyId)
107         throws com.liferay.portal.PortalException,
108             com.liferay.portal.SystemException;
109 
110     public com.liferay.portal.model.Group getFriendlyURLGroup(long companyId,
111         java.lang.String friendlyURL)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Group getGroup(long companyId,
116         java.lang.String name)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     public java.util.List<com.liferay.portal.model.Group> getNullFriendlyURLGroups()
121         throws com.liferay.portal.SystemException;
122 
123     public com.liferay.portal.model.Group getOrganizationGroup(long companyId,
124         long organizationId)
125         throws com.liferay.portal.PortalException,
126             com.liferay.portal.SystemException;
127 
128     public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
129         java.util.List<com.liferay.portal.model.Organization> organizations);
130 
131     public java.util.List<com.liferay.portal.model.Group> getRoleGroups(
132         long roleId) throws com.liferay.portal.SystemException;
133 
134     public com.liferay.portal.model.Group getStagingGroup(long liveGroupId)
135         throws com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public com.liferay.portal.model.Group getUserGroup(long companyId,
139         long userId)
140         throws com.liferay.portal.PortalException,
141             com.liferay.portal.SystemException;
142 
143     public com.liferay.portal.model.Group getUserGroupGroup(long companyId,
144         long userGroupId)
145         throws com.liferay.portal.PortalException,
146             com.liferay.portal.SystemException;
147 
148     public java.util.List<com.liferay.portal.model.Group> getUserGroups(
149         long userId) throws com.liferay.portal.SystemException;
150 
151     public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
152         java.util.List<com.liferay.portal.model.UserGroup> userGroups);
153 
154     public boolean hasRoleGroup(long roleId, long groupId)
155         throws com.liferay.portal.SystemException;
156 
157     public boolean hasStagingGroup(long liveGroupId)
158         throws com.liferay.portal.SystemException;
159 
160     public boolean hasUserGroup(long userId, long groupId)
161         throws com.liferay.portal.SystemException;
162 
163     public java.util.List<com.liferay.portal.model.Group> search(
164         long companyId, java.lang.String name, java.lang.String description,
165         java.util.LinkedHashMap<String, Object> params, int start, int end)
166         throws com.liferay.portal.SystemException;
167 
168     public java.util.List<com.liferay.portal.model.Group> search(
169         long companyId, java.lang.String name, java.lang.String description,
170         java.util.LinkedHashMap<String, Object> params, int start, int end,
171         com.liferay.portal.kernel.util.OrderByComparator obc)
172         throws com.liferay.portal.SystemException;
173 
174     public int searchCount(long companyId, java.lang.String name,
175         java.lang.String description,
176         java.util.LinkedHashMap<String, Object> params)
177         throws com.liferay.portal.SystemException;
178 
179     public void setRoleGroups(long roleId, long[] groupIds)
180         throws com.liferay.portal.SystemException;
181 
182     public void unsetRoleGroups(long roleId, long[] groupIds)
183         throws com.liferay.portal.SystemException;
184 
185     public void unsetUserGroups(long userId, long[] groupIds)
186         throws com.liferay.portal.SystemException;
187 
188     public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
189         java.lang.String friendlyURL)
190         throws com.liferay.portal.PortalException,
191             com.liferay.portal.SystemException;
192 
193     public com.liferay.portal.model.Group updateGroup(long groupId,
194         java.lang.String name, java.lang.String description, int type,
195         java.lang.String friendlyURL, boolean active)
196         throws com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException;
198 
199     public com.liferay.portal.model.Group updateGroup(long groupId,
200         java.lang.String typeSettings)
201         throws com.liferay.portal.PortalException,
202             com.liferay.portal.SystemException;
203 
204     public com.liferay.portal.model.Group updateWorkflow(long groupId,
205         boolean workflowEnabled, int workflowStages,
206         java.lang.String workflowRoleNames)
207         throws com.liferay.portal.PortalException,
208             com.liferay.portal.SystemException;
209 }