001    /**
002     * Copyright (c) 2000-2011 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.portlet.social.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the social request local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see SocialRequestLocalService
030     * @see com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl
031     * @see com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl
032     * @generated
033     */
034    public class SocialRequestLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the social request to the database. Also notifies the appropriate model listeners.
043            *
044            * @param socialRequest the social request
045            * @return the social request that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.social.model.SocialRequest addSocialRequest(
049                    com.liferay.portlet.social.model.SocialRequest socialRequest)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addSocialRequest(socialRequest);
052            }
053    
054            /**
055            * Creates a new social request with the primary key. Does not add the social request to the database.
056            *
057            * @param requestId the primary key for the new social request
058            * @return the new social request
059            */
060            public static com.liferay.portlet.social.model.SocialRequest createSocialRequest(
061                    long requestId) {
062                    return getService().createSocialRequest(requestId);
063            }
064    
065            /**
066            * Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param requestId the primary key of the social request
069            * @throws PortalException if a social request with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteSocialRequest(long requestId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteSocialRequest(requestId);
076            }
077    
078            /**
079            * Deletes the social request from the database. Also notifies the appropriate model listeners.
080            *
081            * @param socialRequest the social request
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteSocialRequest(
085                    com.liferay.portlet.social.model.SocialRequest socialRequest)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteSocialRequest(socialRequest);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the social request with the primary key.
163            *
164            * @param requestId the primary key of the social request
165            * @return the social request
166            * @throws PortalException if a social request with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.social.model.SocialRequest getSocialRequest(
170                    long requestId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getSocialRequest(requestId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the social request with the UUID in the group.
185            *
186            * @param uuid the UUID of social request
187            * @param groupId the group id of the social request
188            * @return the social request
189            * @throws PortalException if a social request with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.social.model.SocialRequest getSocialRequestByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getSocialRequestByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the social requests.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of social requests
207            * @param end the upper bound of the range of social requests (not inclusive)
208            * @return the range of social requests
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getSocialRequests(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getSocialRequests(start, end);
215            }
216    
217            /**
218            * Returns the number of social requests.
219            *
220            * @return the number of social requests
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getSocialRequestsCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getSocialRequestsCount();
226            }
227    
228            /**
229            * Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param socialRequest the social request
232            * @return the social request that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.social.model.SocialRequest updateSocialRequest(
236                    com.liferay.portlet.social.model.SocialRequest socialRequest)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateSocialRequest(socialRequest);
239            }
240    
241            /**
242            * Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param socialRequest the social request
245            * @param merge whether to merge the social request 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.
246            * @return the social request that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.social.model.SocialRequest updateSocialRequest(
250                    com.liferay.portlet.social.model.SocialRequest socialRequest,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateSocialRequest(socialRequest, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            /**
275            * Adds a social request to the database.
276            *
277            * <p>
278            * In order to add a social request, both the requesting user and the
279            * receiving user must be from the same company and neither of them can be
280            * the default user.
281            * </p>
282            *
283            * @param userId the primary key of the requesting user
284            * @param groupId the primary key of the group
285            * @param className the class name of the asset that is the subject of the
286            request
287            * @param classPK the primary key of the asset that is the subject of the
288            request
289            * @param type the request's type
290            * @param extraData the extra data regarding the request
291            * @param receiverUserId the primary key of the user receiving the request
292            * @return the social request
293            * @throws PortalException if the users could not be found, if the users
294            were not from the same company, or if either of the users was
295            the default user
296            * @throws SystemException if a system exception occurred
297            */
298            public static com.liferay.portlet.social.model.SocialRequest addRequest(
299                    long userId, long groupId, java.lang.String className, long classPK,
300                    int type, java.lang.String extraData, long receiverUserId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    return getService()
304                                       .addRequest(userId, groupId, className, classPK, type,
305                            extraData, receiverUserId);
306            }
307    
308            /**
309            * Removes all the social requests for the receiving user.
310            *
311            * @param receiverUserId the primary key of the receiving user
312            * @throws SystemException if a system exception occurred
313            */
314            public static void deleteReceiverUserRequests(long receiverUserId)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    getService().deleteReceiverUserRequests(receiverUserId);
317            }
318    
319            /**
320            * Removes the social request identified by its primary key from the
321            * database.
322            *
323            * @param requestId the primary key of the social request
324            * @throws PortalException if the social request could not be found
325            * @throws SystemException if a system exception occurred
326            */
327            public static void deleteRequest(long requestId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService().deleteRequest(requestId);
331            }
332    
333            /**
334            * Removes the social request from the database.
335            *
336            * @param request the social request to be removed
337            * @throws SystemException if a system exception occurred
338            */
339            public static void deleteRequest(
340                    com.liferay.portlet.social.model.SocialRequest request)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    getService().deleteRequest(request);
343            }
344    
345            /**
346            * Removes all the social requests for the requesting user.
347            *
348            * @param userId the primary key of the requesting user
349            * @throws SystemException if a system exception occurred
350            */
351            public static void deleteUserRequests(long userId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    getService().deleteUserRequests(userId);
354            }
355    
356            /**
357            * Returns a range of all the social requests for the receiving user.
358            *
359            * <p>
360            * Useful when paginating results. Returns a maximum of <code>end -
361            * start</code> instances. <code>start</code> and <code>end</code> are not
362            * primary keys, they are indexes in the result set. Thus, <code>0</code>
363            * refers to the first result in the set. Setting both <code>start</code>
364            * and <code>end</code> to {@link
365            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the
366            * full result set.
367            * </p>
368            *
369            * @param receiverUserId the primary key of the receiving user
370            * @param start the lower bound of the range of results
371            * @param end the upper bound of the range of results (not inclusive)
372            * @return the range of matching social requests
373            * @throws SystemException if a system exception occurred
374            */
375            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
376                    long receiverUserId, int start, int end)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getReceiverUserRequests(receiverUserId, start, end);
379            }
380    
381            /**
382            * Returns a range of all the social requests with the given status for the
383            * receiving user.
384            *
385            * <p>
386            * Useful when paginating results. Returns a maximum of <code>end -
387            * start</code> instances. <code>start</code> and <code>end</code> are not
388            * primary keys, they are indexes in the result set. Thus, <code>0</code>
389            * refers to the first result in the set. Setting both <code>start</code>
390            * and <code>end</code> to {@link
391            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the
392            * full result set.
393            * </p>
394            *
395            * @param receiverUserId the primary key of the receiving user
396            * @param status the social request's status
397            * @param start the lower bound of the range of results
398            * @param end the upper bound of the range of results (not inclusive)
399            * @return the range of matching social requests
400            * @throws SystemException if a system exception occurred
401            */
402            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
403                    long receiverUserId, int status, int start, int end)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService()
406                                       .getReceiverUserRequests(receiverUserId, status, start, end);
407            }
408    
409            /**
410            * Returns the number of social requests for the receiving user.
411            *
412            * @param receiverUserId the primary key of the receiving user
413            * @return the number of matching social requests
414            * @throws SystemException if a system exception occurred
415            */
416            public static int getReceiverUserRequestsCount(long receiverUserId)
417                    throws com.liferay.portal.kernel.exception.SystemException {
418                    return getService().getReceiverUserRequestsCount(receiverUserId);
419            }
420    
421            /**
422            * Returns the number of social requests with the given status for the
423            * receiving user.
424            *
425            * @param receiverUserId the primary key of the receiving user
426            * @param status the social request's status
427            * @return the number of matching social requests
428            * @throws SystemException if a system exception occurred
429            */
430            public static int getReceiverUserRequestsCount(long receiverUserId,
431                    int status) throws com.liferay.portal.kernel.exception.SystemException {
432                    return getService().getReceiverUserRequestsCount(receiverUserId, status);
433            }
434    
435            /**
436            * Returns a range of all the social requests for the requesting user.
437            *
438            * <p>
439            * Useful when paginating results. Returns a maximum of <code>end -
440            * start</code> instances. <code>start</code> and <code>end</code> are not
441            * primary keys, they are indexes in the result set. Thus, <code>0</code>
442            * refers to the first result in the set. Setting both <code>start</code>
443            * and <code>end</code> to {@link
444            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the
445            * full result set.
446            * </p>
447            *
448            * @param userId the primary key of the requesting user
449            * @param start the lower bound of the range of results
450            * @param end the upper bound of the range of results (not inclusive)
451            * @return the range of matching social requests
452            * @throws SystemException if a system exception occurred
453            */
454            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
455                    long userId, int start, int end)
456                    throws com.liferay.portal.kernel.exception.SystemException {
457                    return getService().getUserRequests(userId, start, end);
458            }
459    
460            /**
461            * Returns a range of all the social requests with the given status for the
462            * requesting user.
463            *
464            * <p>
465            * Useful when paginating results. Returns a maximum of <code>end -
466            * start</code> instances. <code>start</code> and <code>end</code> are not
467            * primary keys, they are indexes in the result set. Thus, <code>0</code>
468            * refers to the first result in the set. Setting both <code>start</code>
469            * and <code>end</code> to {@link
470            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the
471            * full result set.
472            * </p>
473            *
474            * @param userId the primary key of the requesting user
475            * @param status the social request's status
476            * @param start the lower bound of the range of results
477            * @param end the upper bound of the range of results (not inclusive)
478            * @return the range of matching social requests
479            * @throws SystemException if a system exception occurred
480            */
481            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
482                    long userId, int status, int start, int end)
483                    throws com.liferay.portal.kernel.exception.SystemException {
484                    return getService().getUserRequests(userId, status, start, end);
485            }
486    
487            /**
488            * Returns the number of social requests for the requesting user.
489            *
490            * @param userId the primary key of the requesting user
491            * @return the number of matching social requests
492            * @throws SystemException if a system exception occurred
493            */
494            public static int getUserRequestsCount(long userId)
495                    throws com.liferay.portal.kernel.exception.SystemException {
496                    return getService().getUserRequestsCount(userId);
497            }
498    
499            /**
500            * Returns the number of social requests with the given status for the
501            * requesting user.
502            *
503            * @param userId the primary key of the requesting user
504            * @param status the social request's status
505            * @return the number of matching social request
506            * @throws SystemException if a system exception occurred
507            */
508            public static int getUserRequestsCount(long userId, int status)
509                    throws com.liferay.portal.kernel.exception.SystemException {
510                    return getService().getUserRequestsCount(userId, status);
511            }
512    
513            /**
514            * Returns <code>true</code> if a matching social requests exists in the
515            * database.
516            *
517            * @param userId the primary key of the requesting user
518            * @param className the class name of the asset that is the subject of the
519            request
520            * @param classPK the primary key of the asset that is the subject of the
521            request
522            * @param type the request's type
523            * @param status the social request's status
524            * @return <code>true</code> if the request exists; <code>false</code>
525            otherwise
526            * @throws SystemException if a system exception occurred
527            */
528            public static boolean hasRequest(long userId, java.lang.String className,
529                    long classPK, int type, int status)
530                    throws com.liferay.portal.kernel.exception.SystemException {
531                    return getService().hasRequest(userId, className, classPK, type, status);
532            }
533    
534            /**
535            * Returns <code>true</code> if a matching social request exists in the
536            * database.
537            *
538            * @param userId the primary key of the requesting user
539            * @param className the class name of the asset that is the subject of the
540            request
541            * @param classPK the primary key of the asset that is the subject of the
542            request
543            * @param type the request's type
544            * @param receiverUserId the primary key of the receiving user
545            * @param status the social request's status
546            * @return <code>true</code> if the social request exists;
547            <code>false</code> otherwise
548            * @throws SystemException if a system exception occurred
549            */
550            public static boolean hasRequest(long userId, java.lang.String className,
551                    long classPK, int type, long receiverUserId, int status)
552                    throws com.liferay.portal.kernel.exception.SystemException {
553                    return getService()
554                                       .hasRequest(userId, className, classPK, type,
555                            receiverUserId, status);
556            }
557    
558            /**
559            * Updates the social request replacing its status.
560            *
561            * <p>
562            * If the status is updated to {@link
563            * com.liferay.portlet.social.model.SocialRequestConstants#STATUS_CONFIRM}
564            * then {@link
565            * com.liferay.portlet.social.service.SocialRequestInterpreterLocalService#processConfirmation(
566            * SocialRequest, ThemeDisplay)} is called. If the status is updated to
567            * {@link
568            * com.liferay.portlet.social.model.SocialRequestConstants#STATUS_IGNORE}
569            * then {@link
570            * com.liferay.portlet.social.service.SocialRequestInterpreterLocalService#processRejection(
571            * SocialRequest, ThemeDisplay)} is called.
572            * </p>
573            *
574            * @param requestId the primary key of the social request
575            * @param status the new status
576            * @param themeDisplay the theme display
577            * @return the updated social request
578            * @throws PortalException if the social request could not be found
579            * @throws SystemException if a system exception occurred
580            */
581            public static com.liferay.portlet.social.model.SocialRequest updateRequest(
582                    long requestId, int status,
583                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
584                    throws com.liferay.portal.kernel.exception.PortalException,
585                            com.liferay.portal.kernel.exception.SystemException {
586                    return getService().updateRequest(requestId, status, themeDisplay);
587            }
588    
589            public static SocialRequestLocalService getService() {
590                    if (_service == null) {
591                            _service = (SocialRequestLocalService)PortalBeanLocatorUtil.locate(SocialRequestLocalService.class.getName());
592    
593                            ReferenceRegistry.registerReference(SocialRequestLocalServiceUtil.class,
594                                    "_service");
595                            MethodCache.remove(SocialRequestLocalService.class);
596                    }
597    
598                    return _service;
599            }
600    
601            public void setService(SocialRequestLocalService service) {
602                    MethodCache.remove(SocialRequestLocalService.class);
603    
604                    _service = service;
605    
606                    ReferenceRegistry.registerReference(SocialRequestLocalServiceUtil.class,
607                            "_service");
608                    MethodCache.remove(SocialRequestLocalService.class);
609            }
610    
611            private static SocialRequestLocalService _service;
612    }