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 relation local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl} 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.SocialRelationLocalServiceImpl} 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 SocialRelationLocalService
032     * @see com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl
033     * @see com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl
034     * @generated
035     */
036    public class SocialRelationLocalServiceUtil {
037            /**
038            * Adds the social relation to the database. Also notifies the appropriate model listeners.
039            *
040            * @param socialRelation the social relation to add
041            * @return the social relation that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.social.model.SocialRelation addSocialRelation(
045                    com.liferay.portlet.social.model.SocialRelation socialRelation)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addSocialRelation(socialRelation);
048            }
049    
050            /**
051            * Creates a new social relation with the primary key. Does not add the social relation to the database.
052            *
053            * @param relationId the primary key for the new social relation
054            * @return the new social relation
055            */
056            public static com.liferay.portlet.social.model.SocialRelation createSocialRelation(
057                    long relationId) {
058                    return getService().createSocialRelation(relationId);
059            }
060    
061            /**
062            * Deletes the social relation with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param relationId the primary key of the social relation to delete
065            * @throws PortalException if a social relation with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteSocialRelation(long relationId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteSocialRelation(relationId);
072            }
073    
074            /**
075            * Deletes the social relation from the database. Also notifies the appropriate model listeners.
076            *
077            * @param socialRelation the social relation to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteSocialRelation(
081                    com.liferay.portlet.social.model.SocialRelation socialRelation)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteSocialRelation(socialRelation);
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 relation with the primary key.
159            *
160            * @param relationId the primary key of the social relation to get
161            * @return the social relation
162            * @throws PortalException if a social relation 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.SocialRelation getSocialRelation(
166                    long relationId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getSocialRelation(relationId);
170            }
171    
172            /**
173            * Gets a range of all the social relations.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of social relations to return
180            * @param end the upper bound of the range of social relations to return (not inclusive)
181            * @return the range of social relations
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getSocialRelations(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getSocialRelations(start, end);
188            }
189    
190            /**
191            * Gets the number of social relations.
192            *
193            * @return the number of social relations
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getSocialRelationsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getSocialRelationsCount();
199            }
200    
201            /**
202            * Updates the social relation in the database. Also notifies the appropriate model listeners.
203            *
204            * @param socialRelation the social relation to update
205            * @return the social relation that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portlet.social.model.SocialRelation updateSocialRelation(
209                    com.liferay.portlet.social.model.SocialRelation socialRelation)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateSocialRelation(socialRelation);
212            }
213    
214            /**
215            * Updates the social relation in the database. Also notifies the appropriate model listeners.
216            *
217            * @param socialRelation the social relation to update
218            * @param merge whether to merge the social relation 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.
219            * @return the social relation that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portlet.social.model.SocialRelation updateSocialRelation(
223                    com.liferay.portlet.social.model.SocialRelation socialRelation,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updateSocialRelation(socialRelation, merge);
227            }
228    
229            public static com.liferay.portlet.social.model.SocialRelation addRelation(
230                    long userId1, long userId2, int type)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException {
233                    return getService().addRelation(userId1, userId2, type);
234            }
235    
236            public static void deleteRelation(long relationId)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException {
239                    getService().deleteRelation(relationId);
240            }
241    
242            public static void deleteRelation(long userId1, long userId2, int type)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException {
245                    getService().deleteRelation(userId1, userId2, type);
246            }
247    
248            public static void deleteRelation(
249                    com.liferay.portlet.social.model.SocialRelation relation)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException {
252                    getService().deleteRelation(relation);
253            }
254    
255            public static void deleteRelations(long userId)
256                    throws com.liferay.portal.kernel.exception.SystemException {
257                    getService().deleteRelations(userId);
258            }
259    
260            public static com.liferay.portlet.social.model.SocialRelation getRelation(
261                    long relationId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService().getRelation(relationId);
265            }
266    
267            public static com.liferay.portlet.social.model.SocialRelation getRelation(
268                    long userId1, long userId2, int type)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService().getRelation(userId1, userId2, type);
272            }
273    
274            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getRelations(
275                    long userId, int type, int start, int end)
276                    throws com.liferay.portal.kernel.exception.SystemException {
277                    return getService().getRelations(userId, type, start, end);
278            }
279    
280            public static int getRelationsCount(long userId, int type)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService().getRelationsCount(userId, type);
283            }
284    
285            public static boolean hasRelation(long userId1, long userId2, int type)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    return getService().hasRelation(userId1, userId2, type);
288            }
289    
290            public static boolean isRelatable(long userId1, long userId2, int type)
291                    throws com.liferay.portal.kernel.exception.SystemException {
292                    return getService().isRelatable(userId1, userId2, type);
293            }
294    
295            public static SocialRelationLocalService getService() {
296                    if (_service == null) {
297                            _service = (SocialRelationLocalService)PortalBeanLocatorUtil.locate(SocialRelationLocalService.class.getName());
298                    }
299    
300                    return _service;
301            }
302    
303            public void setService(SocialRelationLocalService service) {
304                    _service = service;
305            }
306    
307            private static SocialRelationLocalService _service;
308    }