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