001    /**
002     * Copyright (c) 2000-2011 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.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            public static com.liferay.portlet.social.model.SocialRequest addRequest(
275                    long userId, long groupId, java.lang.String className, long classPK,
276                    int type, java.lang.String extraData, long receiverUserId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addRequest(userId, groupId, className, classPK, type,
281                            extraData, receiverUserId);
282            }
283    
284            public static void deleteReceiverUserRequests(long receiverUserId)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteReceiverUserRequests(receiverUserId);
287            }
288    
289            public static void deleteRequest(long requestId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteRequest(requestId);
293            }
294    
295            public static void deleteRequest(
296                    com.liferay.portlet.social.model.SocialRequest request)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    getService().deleteRequest(request);
299            }
300    
301            public static void deleteUserRequests(long userId)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteUserRequests(userId);
304            }
305    
306            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
307                    long receiverUserId, int start, int end)
308                    throws com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getReceiverUserRequests(receiverUserId, start, end);
310            }
311    
312            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
313                    long receiverUserId, int status, int start, int end)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService()
316                                       .getReceiverUserRequests(receiverUserId, status, start, end);
317            }
318    
319            public static int getReceiverUserRequestsCount(long receiverUserId)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService().getReceiverUserRequestsCount(receiverUserId);
322            }
323    
324            public static int getReceiverUserRequestsCount(long receiverUserId,
325                    int status) throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getReceiverUserRequestsCount(receiverUserId, status);
327            }
328    
329            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
330                    long userId, int start, int end)
331                    throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getUserRequests(userId, start, end);
333            }
334    
335            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
336                    long userId, int status, int start, int end)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getUserRequests(userId, status, start, end);
339            }
340    
341            public static int getUserRequestsCount(long userId)
342                    throws com.liferay.portal.kernel.exception.SystemException {
343                    return getService().getUserRequestsCount(userId);
344            }
345    
346            public static int getUserRequestsCount(long userId, int status)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getUserRequestsCount(userId, status);
349            }
350    
351            public static boolean hasRequest(long userId, java.lang.String className,
352                    long classPK, int type, int status)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().hasRequest(userId, className, classPK, type, status);
355            }
356    
357            public static boolean hasRequest(long userId, java.lang.String className,
358                    long classPK, int type, long receiverUserId, int status)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService()
361                                       .hasRequest(userId, className, classPK, type,
362                            receiverUserId, status);
363            }
364    
365            public static com.liferay.portlet.social.model.SocialRequest updateRequest(
366                    long requestId, int status,
367                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService().updateRequest(requestId, status, themeDisplay);
371            }
372    
373            public static SocialRequestLocalService getService() {
374                    if (_service == null) {
375                            _service = (SocialRequestLocalService)PortalBeanLocatorUtil.locate(SocialRequestLocalService.class.getName());
376    
377                            ReferenceRegistry.registerReference(SocialRequestLocalServiceUtil.class,
378                                    "_service");
379                            MethodCache.remove(SocialRequestLocalService.class);
380                    }
381    
382                    return _service;
383            }
384    
385            public void setService(SocialRequestLocalService service) {
386                    MethodCache.remove(SocialRequestLocalService.class);
387    
388                    _service = service;
389    
390                    ReferenceRegistry.registerReference(SocialRequestLocalServiceUtil.class,
391                            "_service");
392                    MethodCache.remove(SocialRequestLocalService.class);
393            }
394    
395            private static SocialRequestLocalService _service;
396    }