001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the user group local service. This utility wraps {@link com.liferay.portal.service.impl.UserGroupLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see UserGroupLocalService
032     * @see com.liferay.portal.service.base.UserGroupLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.UserGroupLocalServiceImpl
034     * @generated
035     */
036    public class UserGroupLocalServiceUtil {
037            /**
038            * Adds the user group to the database. Also notifies the appropriate model listeners.
039            *
040            * @param userGroup the user group to add
041            * @return the user group that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.UserGroup addUserGroup(
045                    com.liferay.portal.model.UserGroup userGroup)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addUserGroup(userGroup);
048            }
049    
050            /**
051            * Creates a new user group with the primary key. Does not add the user group to the database.
052            *
053            * @param userGroupId the primary key for the new user group
054            * @return the new user group
055            */
056            public static com.liferay.portal.model.UserGroup createUserGroup(
057                    long userGroupId) {
058                    return getService().createUserGroup(userGroupId);
059            }
060    
061            /**
062            * Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param userGroupId the primary key of the user group to delete
065            * @throws PortalException if a user group with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteUserGroup(long userGroupId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteUserGroup(userGroupId);
072            }
073    
074            /**
075            * Deletes the user group from the database. Also notifies the appropriate model listeners.
076            *
077            * @param userGroup the user group to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteUserGroup(
081                    com.liferay.portal.model.UserGroup userGroup)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteUserGroup(userGroup);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the user group with the primary key.
159            *
160            * @param userGroupId the primary key of the user group to get
161            * @return the user group
162            * @throws PortalException if a user group with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.UserGroup getUserGroup(
166                    long userGroupId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getUserGroup(userGroupId);
170            }
171    
172            /**
173            * Gets a range of all the user groups.
174            *
175            * <p>
176            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
177            * </p>
178            *
179            * @param start the lower bound of the range of user groups to return
180            * @param end the upper bound of the range of user groups to return (not inclusive)
181            * @return the range of user groups
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getUserGroups(start, end);
188            }
189    
190            /**
191            * Gets the number of user groups.
192            *
193            * @return the number of user groups
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getUserGroupsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getUserGroupsCount();
199            }
200    
201            /**
202            * Updates the user group in the database. Also notifies the appropriate model listeners.
203            *
204            * @param userGroup the user group to update
205            * @return the user group that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.UserGroup updateUserGroup(
209                    com.liferay.portal.model.UserGroup userGroup)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateUserGroup(userGroup);
212            }
213    
214            /**
215            * Updates the user group in the database. Also notifies the appropriate model listeners.
216            *
217            * @param userGroup the user group to update
218            * @param merge whether to merge the user group with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
219            * @return the user group that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.UserGroup updateUserGroup(
223                    com.liferay.portal.model.UserGroup userGroup, boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().updateUserGroup(userGroup, merge);
226            }
227    
228            public static void addGroupUserGroups(long groupId, long[] userGroupIds)
229                    throws com.liferay.portal.kernel.exception.SystemException {
230                    getService().addGroupUserGroups(groupId, userGroupIds);
231            }
232    
233            public static com.liferay.portal.model.UserGroup addUserGroup(long userId,
234                    long companyId, java.lang.String name, java.lang.String description)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException {
237                    return getService().addUserGroup(userId, companyId, name, description);
238            }
239    
240            public static void clearUserUserGroups(long userId)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    getService().clearUserUserGroups(userId);
243            }
244    
245            public static void copyUserGroupLayouts(long userGroupId, long[] userIds)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    getService().copyUserGroupLayouts(userGroupId, userIds);
249            }
250    
251            public static void copyUserGroupLayouts(long[] userGroupIds, long userId)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException {
254                    getService().copyUserGroupLayouts(userGroupIds, userId);
255            }
256    
257            public static void copyUserGroupLayouts(long userGroupId, long userId)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException {
260                    getService().copyUserGroupLayouts(userGroupId, userId);
261            }
262    
263            public static com.liferay.portal.model.UserGroup getUserGroup(
264                    long companyId, java.lang.String name)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService().getUserGroup(companyId, name);
268            }
269    
270            public static java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
271                    long companyId)
272                    throws com.liferay.portal.kernel.exception.SystemException {
273                    return getService().getUserGroups(companyId);
274            }
275    
276            public static java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
277                    long[] userGroupIds)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    return getService().getUserGroups(userGroupIds);
281            }
282    
283            public static java.util.List<com.liferay.portal.model.UserGroup> getUserUserGroups(
284                    long userId) throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().getUserUserGroups(userId);
286            }
287    
288            public static boolean hasGroupUserGroup(long groupId, long userGroupId)
289                    throws com.liferay.portal.kernel.exception.SystemException {
290                    return getService().hasGroupUserGroup(groupId, userGroupId);
291            }
292    
293            public static java.util.List<com.liferay.portal.model.UserGroup> search(
294                    long companyId, java.lang.String name, java.lang.String description,
295                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
296                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .search(companyId, name, description, params, start, end, obc);
300            }
301    
302            public static int searchCount(long companyId, java.lang.String name,
303                    java.lang.String description,
304                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
305                    throws com.liferay.portal.kernel.exception.SystemException {
306                    return getService().searchCount(companyId, name, description, params);
307            }
308    
309            public static void setUserUserGroups(long userId, long[] userGroupIds)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService().setUserUserGroups(userId, userGroupIds);
313            }
314    
315            public static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    getService().unsetGroupUserGroups(groupId, userGroupIds);
318            }
319    
320            public static com.liferay.portal.model.UserGroup updateUserGroup(
321                    long companyId, long userGroupId, java.lang.String name,
322                    java.lang.String description)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    return getService()
326                                       .updateUserGroup(companyId, userGroupId, name, description);
327            }
328    
329            public static UserGroupLocalService getService() {
330                    if (_service == null) {
331                            _service = (UserGroupLocalService)PortalBeanLocatorUtil.locate(UserGroupLocalService.class.getName());
332                    }
333    
334                    return _service;
335            }
336    
337            public void setService(UserGroupLocalService service) {
338                    _service = service;
339            }
340    
341            private static UserGroupLocalService _service;
342    }