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