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     * Provides the local service utility for UserGroupRole. This utility wraps
022     * {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
027     *
028     * @author Brian Wing Shun Chan
029     * @see UserGroupRoleLocalService
030     * @see com.liferay.portal.service.base.UserGroupRoleLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl
032     * @generated
033     */
034    public class UserGroupRoleLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the user group role to the database. Also notifies the appropriate model listeners.
043            *
044            * @param userGroupRole the user group role
045            * @return the user group role that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.UserGroupRole addUserGroupRole(
049                    com.liferay.portal.model.UserGroupRole userGroupRole)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addUserGroupRole(userGroupRole);
052            }
053    
054            /**
055            * Creates a new user group role with the primary key. Does not add the user group role to the database.
056            *
057            * @param userGroupRolePK the primary key for the new user group role
058            * @return the new user group role
059            */
060            public static com.liferay.portal.model.UserGroupRole createUserGroupRole(
061                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK) {
062                    return getService().createUserGroupRole(userGroupRolePK);
063            }
064    
065            /**
066            * Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param userGroupRolePK the primary key of the user group role
069            * @return the user group role that was removed
070            * @throws PortalException if a user group role with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
074                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteUserGroupRole(userGroupRolePK);
078            }
079    
080            /**
081            * Deletes the user group role from the database. Also notifies the appropriate model listeners.
082            *
083            * @param userGroupRole the user group role
084            * @return the user group role that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
088                    com.liferay.portal.model.UserGroupRole userGroupRole)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteUserGroupRole(userGroupRole);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portal.model.UserGroupRole fetchUserGroupRole(
184                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchUserGroupRole(userGroupRolePK);
187            }
188    
189            /**
190            * Returns the user group role with the primary key.
191            *
192            * @param userGroupRolePK the primary key of the user group role
193            * @return the user group role
194            * @throws PortalException if a user group role with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portal.model.UserGroupRole getUserGroupRole(
198                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
199                    throws com.liferay.portal.kernel.exception.PortalException,
200                            com.liferay.portal.kernel.exception.SystemException {
201                    return getService().getUserGroupRole(userGroupRolePK);
202            }
203    
204            public static com.liferay.portal.model.PersistedModel getPersistedModel(
205                    java.io.Serializable primaryKeyObj)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getPersistedModel(primaryKeyObj);
209            }
210    
211            /**
212            * Returns a range of all the user group roles.
213            *
214            * <p>
215            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
216            * </p>
217            *
218            * @param start the lower bound of the range of user group roles
219            * @param end the upper bound of the range of user group roles (not inclusive)
220            * @return the range of user group roles
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getUserGroupRoles(start, end);
227            }
228    
229            /**
230            * Returns the number of user group roles.
231            *
232            * @return the number of user group roles
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getUserGroupRolesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getUserGroupRolesCount();
238            }
239    
240            /**
241            * Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param userGroupRole the user group role
244            * @return the user group role that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portal.model.UserGroupRole updateUserGroupRole(
248                    com.liferay.portal.model.UserGroupRole userGroupRole)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateUserGroupRole(userGroupRole);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static java.util.List<com.liferay.portal.model.UserGroupRole> addUserGroupRoles(
272                    long userId, long groupId, long[] roleIds)
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    return getService().addUserGroupRoles(userId, groupId, roleIds);
275            }
276    
277            public static java.util.List<com.liferay.portal.model.UserGroupRole> addUserGroupRoles(
278                    long[] userIds, long groupId, long roleId)
279                    throws com.liferay.portal.kernel.exception.SystemException {
280                    return 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> getUserGroupRolesByGroup(
337                    long groupId)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getUserGroupRolesByGroup(groupId);
340            }
341    
342            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroupAndRole(
343                    long groupId, long roleId)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getUserGroupRolesByGroupAndRole(groupId, roleId);
346            }
347    
348            public static java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(
349                    long userId, long groupId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService()
352                                       .getUserGroupRolesByUserUserGroupAndGroup(userId, groupId);
353            }
354    
355            public static boolean hasUserGroupRole(long userId, long groupId,
356                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().hasUserGroupRole(userId, groupId, roleId);
358            }
359    
360            public static boolean hasUserGroupRole(long userId, long groupId,
361                    long roleId, boolean inherit)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().hasUserGroupRole(userId, groupId, roleId, inherit);
364            }
365    
366            public static boolean hasUserGroupRole(long userId, long groupId,
367                    java.lang.String roleName)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService().hasUserGroupRole(userId, groupId, roleName);
371            }
372    
373            public static boolean hasUserGroupRole(long userId, long groupId,
374                    java.lang.String roleName, boolean inherit)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException {
377                    return getService().hasUserGroupRole(userId, groupId, roleName, inherit);
378            }
379    
380            public static UserGroupRoleLocalService getService() {
381                    if (_service == null) {
382                            _service = (UserGroupRoleLocalService)PortalBeanLocatorUtil.locate(UserGroupRoleLocalService.class.getName());
383    
384                            ReferenceRegistry.registerReference(UserGroupRoleLocalServiceUtil.class,
385                                    "_service");
386                    }
387    
388                    return _service;
389            }
390    
391            /**
392             * @deprecated As of 6.2.0
393             */
394            public void setService(UserGroupRoleLocalService service) {
395            }
396    
397            private static UserGroupRoleLocalService _service;
398    }