001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see SocialRequestLocalService
032     * @see com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl
033     * @see com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl
034     * @generated
035     */
036    public class SocialRequestLocalServiceUtil {
037            /**
038            * Adds the social request to the database. Also notifies the appropriate model listeners.
039            *
040            * @param socialRequest the social request to add
041            * @return the social request that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.social.model.SocialRequest addSocialRequest(
045                    com.liferay.portlet.social.model.SocialRequest socialRequest)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addSocialRequest(socialRequest);
048            }
049    
050            /**
051            * Creates a new social request with the primary key. Does not add the social request to the database.
052            *
053            * @param requestId the primary key for the new social request
054            * @return the new social request
055            */
056            public static com.liferay.portlet.social.model.SocialRequest createSocialRequest(
057                    long requestId) {
058                    return getService().createSocialRequest(requestId);
059            }
060    
061            /**
062            * Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param requestId the primary key of the social request to delete
065            * @throws PortalException if a social request with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteSocialRequest(long requestId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteSocialRequest(requestId);
072            }
073    
074            /**
075            * Deletes the social request from the database. Also notifies the appropriate model listeners.
076            *
077            * @param socialRequest the social request to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteSocialRequest(
081                    com.liferay.portlet.social.model.SocialRequest socialRequest)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteSocialRequest(socialRequest);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the social request with the primary key.
159            *
160            * @param requestId the primary key of the social request to get
161            * @return the social request
162            * @throws PortalException if a social request with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.social.model.SocialRequest getSocialRequest(
166                    long requestId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getSocialRequest(requestId);
170            }
171    
172            /**
173            * Gets the social request with the UUID and group id.
174            *
175            * @param uuid the UUID of social request to get
176            * @param groupId the group id of the social request to get
177            * @return the social request
178            * @throws PortalException if a social request with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.social.model.SocialRequest getSocialRequestByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getSocialRequestByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the social requests.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of social requests to return
196            * @param end the upper bound of the range of social requests to return (not inclusive)
197            * @return the range of social requests
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getSocialRequests(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getSocialRequests(start, end);
204            }
205    
206            /**
207            * Gets the number of social requests.
208            *
209            * @return the number of social requests
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getSocialRequestsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getSocialRequestsCount();
215            }
216    
217            /**
218            * Updates the social request in the database. Also notifies the appropriate model listeners.
219            *
220            * @param socialRequest the social request to update
221            * @return the social request that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.social.model.SocialRequest updateSocialRequest(
225                    com.liferay.portlet.social.model.SocialRequest socialRequest)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateSocialRequest(socialRequest);
228            }
229    
230            /**
231            * Updates the social request in the database. Also notifies the appropriate model listeners.
232            *
233            * @param socialRequest the social request to update
234            * @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.
235            * @return the social request that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.social.model.SocialRequest updateSocialRequest(
239                    com.liferay.portlet.social.model.SocialRequest socialRequest,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateSocialRequest(socialRequest, merge);
243            }
244    
245            public static com.liferay.portlet.social.model.SocialRequest addRequest(
246                    long userId, long groupId, java.lang.String className, long classPK,
247                    int type, java.lang.String extraData, long receiverUserId)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException {
250                    return getService()
251                                       .addRequest(userId, groupId, className, classPK, type,
252                            extraData, receiverUserId);
253            }
254    
255            public static void deleteReceiverUserRequests(long receiverUserId)
256                    throws com.liferay.portal.kernel.exception.SystemException {
257                    getService().deleteReceiverUserRequests(receiverUserId);
258            }
259    
260            public static void deleteRequest(long requestId)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    getService().deleteRequest(requestId);
264            }
265    
266            public static void deleteUserRequests(long userId)
267                    throws com.liferay.portal.kernel.exception.SystemException {
268                    getService().deleteUserRequests(userId);
269            }
270    
271            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
272                    long receiverUserId, int start, int end)
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    return getService().getReceiverUserRequests(receiverUserId, start, end);
275            }
276    
277            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getReceiverUserRequests(
278                    long receiverUserId, int status, int start, int end)
279                    throws com.liferay.portal.kernel.exception.SystemException {
280                    return getService()
281                                       .getReceiverUserRequests(receiverUserId, status, start, end);
282            }
283    
284            public static int getReceiverUserRequestsCount(long receiverUserId)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    return getService().getReceiverUserRequestsCount(receiverUserId);
287            }
288    
289            public static int getReceiverUserRequestsCount(long receiverUserId,
290                    int status) throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().getReceiverUserRequestsCount(receiverUserId, status);
292            }
293    
294            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
295                    long userId, int start, int end)
296                    throws com.liferay.portal.kernel.exception.SystemException {
297                    return getService().getUserRequests(userId, start, end);
298            }
299    
300            public static java.util.List<com.liferay.portlet.social.model.SocialRequest> getUserRequests(
301                    long userId, int status, int start, int end)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    return getService().getUserRequests(userId, status, start, end);
304            }
305    
306            public static int getUserRequestsCount(long userId)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    return getService().getUserRequestsCount(userId);
309            }
310    
311            public static int getUserRequestsCount(long userId, int status)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService().getUserRequestsCount(userId, status);
314            }
315    
316            public static boolean hasRequest(long userId, java.lang.String className,
317                    long classPK, int type, int status)
318                    throws com.liferay.portal.kernel.exception.SystemException {
319                    return getService().hasRequest(userId, className, classPK, type, status);
320            }
321    
322            public static boolean hasRequest(long userId, java.lang.String className,
323                    long classPK, int type, long receiverUserId, int status)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService()
326                                       .hasRequest(userId, className, classPK, type,
327                            receiverUserId, status);
328            }
329    
330            public static com.liferay.portlet.social.model.SocialRequest updateRequest(
331                    long requestId, int status,
332                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    return getService().updateRequest(requestId, status, themeDisplay);
336            }
337    
338            public static SocialRequestLocalService getService() {
339                    if (_service == null) {
340                            _service = (SocialRequestLocalService)PortalBeanLocatorUtil.locate(SocialRequestLocalService.class.getName());
341                    }
342    
343                    return _service;
344            }
345    
346            public void setService(SocialRequestLocalService service) {
347                    _service = service;
348            }
349    
350            private static SocialRequestLocalService _service;
351    }