001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the user group role local service. This utility wraps {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see UserGroupRoleLocalService
029     * @see com.liferay.portal.service.base.UserGroupRoleLocalServiceBaseImpl
030     * @see com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl
031     * @generated
032     */
033    public class UserGroupRoleLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the user group role to the database. Also notifies the appropriate model listeners.
042            *
043            * @param userGroupRole the user group role
044            * @return the user group role that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portal.model.UserGroupRole addUserGroupRole(
048                    com.liferay.portal.model.UserGroupRole userGroupRole)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addUserGroupRole(userGroupRole);
051            }
052    
053            /**
054            * Creates a new user group role with the primary key. Does not add the user group role to the database.
055            *
056            * @param userGroupRolePK the primary key for the new user group role
057            * @return the new user group role
058            */
059            public static com.liferay.portal.model.UserGroupRole createUserGroupRole(
060                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK) {
061                    return getService().createUserGroupRole(userGroupRolePK);
062            }
063    
064            /**
065            * Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param userGroupRolePK the primary key of the user group role
068            * @return the user group role that was removed
069            * @throws PortalException if a user group role with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
073                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteUserGroupRole(userGroupRolePK);
077            }
078    
079            /**
080            * Deletes the user group role from the database. Also notifies the appropriate model listeners.
081            *
082            * @param userGroupRole the user group role
083            * @return the user group role that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
087                    com.liferay.portal.model.UserGroupRole userGroupRole)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteUserGroupRole(userGroupRole);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portal.model.UserGroupRole fetchUserGroupRole(
168                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchUserGroupRole(userGroupRolePK);
171            }
172    
173            /**
174            * Returns the user group role with the primary key.
175            *
176            * @param userGroupRolePK the primary key of the user group role
177            * @return the user group role
178            * @throws PortalException if a user group role with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portal.model.UserGroupRole getUserGroupRole(
182                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getUserGroupRole(userGroupRolePK);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns a range of all the user group roles.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of user group roles
203            * @param end the upper bound of the range of user group roles (not inclusive)
204            * @return the range of user group roles
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getUserGroupRoles(start, end);
211            }
212    
213            /**
214            * Returns the number of user group roles.
215            *
216            * @return the number of user group roles
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getUserGroupRolesCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getUserGroupRolesCount();
222            }
223    
224            /**
225            * Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param userGroupRole the user group role
228            * @return the user group role that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portal.model.UserGroupRole updateUserGroupRole(
232                    com.liferay.portal.model.UserGroupRole userGroupRole)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateUserGroupRole(userGroupRole);
235            }
236    
237            /**
238            * Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param userGroupRole the user group role
241            * @param merge whether to merge the user group role 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.
242            * @return the user group role that was updated
243            * @throws SystemException if a system exception occurred
244            */
245            public static com.liferay.portal.model.UserGroupRole updateUserGroupRole(
246                    com.liferay.portal.model.UserGroupRole userGroupRole, boolean merge)
247                    throws com.liferay.portal.kernel.exception.SystemException {
248                    return getService().updateUserGroupRole(userGroupRole, merge);
249            }
250    
251            /**
252            * Returns the Spring bean ID for this bean.
253            *
254            * @return the Spring bean ID for this bean
255            */
256            public static java.lang.String getBeanIdentifier() {
257                    return getService().getBeanIdentifier();
258            }
259    
260            /**
261            * Sets the Spring bean ID for this bean.
262            *
263            * @param beanIdentifier the Spring bean ID for this bean
264            */
265            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
266                    getService().setBeanIdentifier(beanIdentifier);
267            }
268    
269            public static void addUserGroupRoles(long userId, long groupId,
270                    long[] roleIds)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService().addUserGroupRoles(userId, groupId, roleIds);
274            }
275    
276            public static void addUserGroupRoles(long[] userIds, long groupId,
277                    long roleId)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    getService().addUserGroupRoles(userIds, groupId, roleId);
281            }
282    
283            public static void deleteUserGroupRoles(long userId, long groupId,
284                    long[] roleIds)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteUserGroupRoles(userId, groupId, roleIds);
287            }
288    
289            public static void deleteUserGroupRoles(long userId, long[] groupIds)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteUserGroupRoles(userId, groupIds);
292            }
293    
294            public static void deleteUserGroupRoles(long[] userIds, long groupId)
295                    throws com.liferay.portal.kernel.exception.SystemException {
296                    getService().deleteUserGroupRoles(userIds, groupId);
297            }
298    
299            public static void deleteUserGroupRoles(long[] userIds, long groupId,
300                    int roleType)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteUserGroupRoles(userIds, groupId, roleType);
303            }
304    
305            public static void deleteUserGroupRoles(long[] userIds, long groupId,
306                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
307                    getService().deleteUserGroupRoles(userIds, groupId, roleId);
308            }
309    
310            public static void deleteUserGroupRolesByGroupId(long groupId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteUserGroupRolesByGroupId(groupId);
313            }
314    
315            public static void deleteUserGroupRolesByRoleId(long roleId)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    getService().deleteUserGroupRolesByRoleId(roleId);
318            }
319    
320            public static void deleteUserGroupRolesByUserId(long userId)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    getService().deleteUserGroupRolesByUserId(userId);
323            }
324    
325            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
326                    long userId) throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getUserGroupRoles(userId);
328            }
329    
330            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
331                    long userId, long groupId)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getUserGroupRoles(userId, groupId);
334            }
335    
336            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroupAndRole(
337                    long groupId, long roleId)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getUserGroupRolesByGroupAndRole(groupId, roleId);
340            }
341    
342            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(
343                    long userId, long groupId)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService()
346                                       .getUserGroupRolesByUserUserGroupAndGroup(userId, groupId);
347            }
348    
349            public static boolean hasUserGroupRole(long userId, long groupId,
350                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().hasUserGroupRole(userId, groupId, roleId);
352            }
353    
354            public static boolean hasUserGroupRole(long userId, long groupId,
355                    long roleId, boolean inherit)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().hasUserGroupRole(userId, groupId, roleId, inherit);
358            }
359    
360            public static boolean hasUserGroupRole(long userId, long groupId,
361                    java.lang.String roleName)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException {
364                    return getService().hasUserGroupRole(userId, groupId, roleName);
365            }
366    
367            public static boolean hasUserGroupRole(long userId, long groupId,
368                    java.lang.String roleName, boolean inherit)
369                    throws com.liferay.portal.kernel.exception.PortalException,
370                            com.liferay.portal.kernel.exception.SystemException {
371                    return getService().hasUserGroupRole(userId, groupId, roleName, inherit);
372            }
373    
374            public static UserGroupRoleLocalService getService() {
375                    if (_service == null) {
376                            _service = (UserGroupRoleLocalService)PortalBeanLocatorUtil.locate(UserGroupRoleLocalService.class.getName());
377    
378                            ReferenceRegistry.registerReference(UserGroupRoleLocalServiceUtil.class,
379                                    "_service");
380                    }
381    
382                    return _service;
383            }
384    
385            /**
386             * @deprecated
387             */
388            public void setService(UserGroupRoleLocalService service) {
389            }
390    
391            private static UserGroupRoleLocalService _service;
392    }