001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.social.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see SocialRelationLocalService
029     * @see com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl
030     * @see com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl
031     * @generated
032     */
033    public class SocialRelationLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the social relation to the database. Also notifies the appropriate model listeners.
042            *
043            * @param socialRelation the social relation
044            * @return the social relation that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.social.model.SocialRelation addSocialRelation(
048                    com.liferay.portlet.social.model.SocialRelation socialRelation)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addSocialRelation(socialRelation);
051            }
052    
053            /**
054            * Creates a new social relation with the primary key. Does not add the social relation to the database.
055            *
056            * @param relationId the primary key for the new social relation
057            * @return the new social relation
058            */
059            public static com.liferay.portlet.social.model.SocialRelation createSocialRelation(
060                    long relationId) {
061                    return getService().createSocialRelation(relationId);
062            }
063    
064            /**
065            * Deletes the social relation with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param relationId the primary key of the social relation
068            * @return the social relation that was removed
069            * @throws PortalException if a social relation with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.social.model.SocialRelation deleteSocialRelation(
073                    long relationId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteSocialRelation(relationId);
077            }
078    
079            /**
080            * Deletes the social relation from the database. Also notifies the appropriate model listeners.
081            *
082            * @param socialRelation the social relation
083            * @return the social relation that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.social.model.SocialRelation deleteSocialRelation(
087                    com.liferay.portlet.social.model.SocialRelation socialRelation)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteSocialRelation(socialRelation);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialRelationModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialRelationModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.social.model.SocialRelation fetchSocialRelation(
168                    long relationId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchSocialRelation(relationId);
171            }
172    
173            /**
174            * Returns the social relation with the primary key.
175            *
176            * @param relationId the primary key of the social relation
177            * @return the social relation
178            * @throws PortalException if a social relation with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.social.model.SocialRelation getSocialRelation(
182                    long relationId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getSocialRelation(relationId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns a range of all the social relations.
197            *
198            * <p>
199            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialRelationModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
200            * </p>
201            *
202            * @param start the lower bound of the range of social relations
203            * @param end the upper bound of the range of social relations (not inclusive)
204            * @return the range of social relations
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getSocialRelations(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getSocialRelations(start, end);
211            }
212    
213            /**
214            * Returns the number of social relations.
215            *
216            * @return the number of social relations
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getSocialRelationsCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getSocialRelationsCount();
222            }
223    
224            /**
225            * Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param socialRelation the social relation
228            * @return the social relation that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portlet.social.model.SocialRelation updateSocialRelation(
232                    com.liferay.portlet.social.model.SocialRelation socialRelation)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateSocialRelation(socialRelation);
235            }
236    
237            /**
238            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            /**
256            * Adds a social relation between the two users to the database.
257            *
258            * @param userId1 the user that is the subject of the relation
259            * @param userId2 the user at the other end of the relation
260            * @param type the type of the relation
261            * @return the social relation
262            * @throws PortalException if the users could not be found, if the users
263            were not from the same company, or if either of the users was the
264            default user
265            * @throws SystemException if a system exception occurred
266            */
267            public static com.liferay.portlet.social.model.SocialRelation addRelation(
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().addRelation(userId1, userId2, type);
272            }
273    
274            /**
275            * Removes the relation (and its inverse in case of a bidirectional
276            * relation) from the database.
277            *
278            * @param relationId the primary key of the relation
279            * @throws PortalException if the relation could not be found
280            * @throws SystemException if a system exception occurred
281            */
282            public static void deleteRelation(long relationId)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    getService().deleteRelation(relationId);
286            }
287    
288            /**
289            * Removes the matching relation (and its inverse in case of a bidirectional
290            * relation) from the database.
291            *
292            * @param userId1 the user that is the subject of the relation
293            * @param userId2 the user at the other end of the relation
294            * @param type the relation's type
295            * @throws PortalException if the relation or its inverse relation (if
296            applicable) could not be found
297            * @throws SystemException if a system exception occurred
298            */
299            public static void deleteRelation(long userId1, long userId2, int type)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteRelation(userId1, userId2, type);
303            }
304    
305            /**
306            * Removes the relation (and its inverse in case of a bidirectional
307            * relation) from the database.
308            *
309            * @param relation the relation to be removed
310            * @throws PortalException if the relation is bidirectional and its inverse
311            relation could not be found
312            * @throws SystemException if a system exception occurred
313            */
314            public static void deleteRelation(
315                    com.liferay.portlet.social.model.SocialRelation relation)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService().deleteRelation(relation);
319            }
320    
321            /**
322            * Removes all relations involving the user from the database.
323            *
324            * @param userId the primary key of the user
325            * @throws SystemException if a system exception occurred
326            */
327            public static void deleteRelations(long userId)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteRelations(userId);
330            }
331    
332            /**
333            * Removes all relations between User1 and User2.
334            *
335            * @param userId1 the user that is the subject of the relation
336            * @param userId2 the user at the other end of the relation
337            * @throws PortalException if the inverse relation could not be found
338            * @throws SystemException if a system exception occurred
339            */
340            public static void deleteRelations(long userId1, long userId2)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    getService().deleteRelations(userId1, userId2);
344            }
345    
346            /**
347            * Returns a range of all the inverse relations of the given type for which
348            * the user is User2 of the relation.
349            *
350            * <p>
351            * Useful when paginating results. Returns a maximum of <code>end -
352            * start</code> instances. <code>start</code> and <code>end</code> are not
353            * primary keys, they are indexes in the result set. Thus, <code>0</code>
354            * refers to the first result in the set. Setting both <code>start</code>
355            * and <code>end</code> to {@link
356            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
357            * result set.
358            * </p>
359            *
360            * @param userId the primary key of the user
361            * @param type the relation's type
362            * @param start the lower bound of the range of results
363            * @param end the upper bound of the range of results (not inclusive)
364            * @return the range of matching relations
365            * @throws SystemException if a system exception occurred
366            */
367            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getInverseRelations(
368                    long userId, int type, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getInverseRelations(userId, type, start, end);
371            }
372    
373            /**
374            * Returns the number of inverse relations of the given type for which the
375            * user is User2 of the relation.
376            *
377            * @param userId the primary key of the user
378            * @param type the relation's type
379            * @return the number of matching relations
380            * @throws SystemException if a system exception occurred
381            */
382            public static int getInverseRelationsCount(long userId, int type)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getInverseRelationsCount(userId, type);
385            }
386    
387            /**
388            * Returns the relation identified by its primary key.
389            *
390            * @param relationId the primary key of the relation
391            * @return Returns the relation
392            * @throws PortalException if the relation could not be found
393            * @throws SystemException if a system exception occurred
394            */
395            public static com.liferay.portlet.social.model.SocialRelation getRelation(
396                    long relationId)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getRelation(relationId);
400            }
401    
402            /**
403            * Returns the relation of the given type between User1 and User2.
404            *
405            * @param userId1 the user that is the subject of the relation
406            * @param userId2 the user at the other end of the relation
407            * @param type the relation's type
408            * @return Returns the relation
409            * @throws PortalException if the relation could not be found
410            * @throws SystemException if a system exception occurred
411            */
412            public static com.liferay.portlet.social.model.SocialRelation getRelation(
413                    long userId1, long userId2, int type)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getRelation(userId1, userId2, type);
417            }
418    
419            /**
420            * Returns a range of all the relations of the given type where the user is
421            * the subject of the relation.
422            *
423            * <p>
424            * Useful when paginating results. Returns a maximum of <code>end -
425            * start</code> instances. <code>start</code> and <code>end</code> are not
426            * primary keys, they are indexes in the result set. Thus, <code>0</code>
427            * refers to the first result in the set. Setting both <code>start</code>
428            * and <code>end</code> to {@link
429            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
430            * result set.
431            * </p>
432            *
433            * @param userId the primary key of the user
434            * @param type the relation's type
435            * @param start the lower bound of the range of results
436            * @param end the upper bound of the range of results (not inclusive)
437            * @return the range of relations
438            * @throws SystemException if a system exception occurred
439            */
440            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getRelations(
441                    long userId, int type, int start, int end)
442                    throws com.liferay.portal.kernel.exception.SystemException {
443                    return getService().getRelations(userId, type, start, end);
444            }
445    
446            /**
447            * Returns a range of all the relations between User1 and User2.
448            *
449            * <p>
450            * Useful when paginating results. Returns a maximum of <code>end -
451            * start</code> instances. <code>start</code> and <code>end</code> are not
452            * primary keys, they are indexes in the result set. Thus, <code>0</code>
453            * refers to the first result in the set. Setting both <code>start</code>
454            * and <code>end</code> to {@link
455            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
456            * result set.
457            * </p>
458            *
459            * @param userId1 the user that is the subject of the relation
460            * @param userId2 the user at the other end of the relation
461            * @param start the lower bound of the range of results
462            * @param end the upper bound of the range of results (not inclusive)
463            * @return the range of relations
464            * @throws SystemException if a system exception occurred
465            */
466            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getRelations(
467                    long userId1, long userId2, int start, int end)
468                    throws com.liferay.portal.kernel.exception.SystemException {
469                    return getService().getRelations(userId1, userId2, start, end);
470            }
471    
472            /**
473            * Returns the number of relations of the given type where the user is the
474            * subject of the relation.
475            *
476            * @param userId the primary key of the user
477            * @param type the relation's type
478            * @return the number of relations
479            * @throws SystemException if a system exception occurred
480            */
481            public static int getRelationsCount(long userId, int type)
482                    throws com.liferay.portal.kernel.exception.SystemException {
483                    return getService().getRelationsCount(userId, type);
484            }
485    
486            /**
487            * Returns the number of relations between User1 and User2.
488            *
489            * @param userId1 the user that is the subject of the relation
490            * @param userId2 the user at the other end of the relation
491            * @return the number of relations
492            * @throws SystemException if a system exception occurred
493            */
494            public static int getRelationsCount(long userId1, long userId2)
495                    throws com.liferay.portal.kernel.exception.SystemException {
496                    return getService().getRelationsCount(userId1, userId2);
497            }
498    
499            /**
500            * Returns <code>true</code> if a relation of the given type exists where
501            * the user with primary key <code>userId1</code> is User1 of the relation
502            * and the user with the primary key <code>userId2</code> is User2 of the
503            * relation.
504            *
505            * @param userId1 the user that is the subject of the relation
506            * @param userId2 the user at the other end of the relation
507            * @param type the relation's type
508            * @return <code>true</code> if the relation exists; <code>false</code>
509            otherwise
510            * @throws SystemException if a system exception occurred
511            */
512            public static boolean hasRelation(long userId1, long userId2, int type)
513                    throws com.liferay.portal.kernel.exception.SystemException {
514                    return getService().hasRelation(userId1, userId2, type);
515            }
516    
517            /**
518            * Returns <code>true</code> if the users can be in a relation of the given
519            * type where the user with primary key <code>userId1</code> is User1 of the
520            * relation and the user with the primary key <code>userId2</code> is User2
521            * of the relation.
522            *
523            * <p>
524            * This method returns <code>false</code> if User1 and User2 are the same,
525            * if either user is the default user, or if a matching relation already
526            * exists.
527            * </p>
528            *
529            * @param userId1 the user that is the subject of the relation
530            * @param userId2 the user at the other end of the relation
531            * @param type the relation's type
532            * @return <code>true</code> if the two users can be in a new relation of
533            the given type; <code>false</code> otherwise
534            * @throws SystemException if a system exception occurred
535            */
536            public static boolean isRelatable(long userId1, long userId2, int type)
537                    throws com.liferay.portal.kernel.exception.SystemException {
538                    return getService().isRelatable(userId1, userId2, type);
539            }
540    
541            public static SocialRelationLocalService getService() {
542                    if (_service == null) {
543                            _service = (SocialRelationLocalService)PortalBeanLocatorUtil.locate(SocialRelationLocalService.class.getName());
544    
545                            ReferenceRegistry.registerReference(SocialRelationLocalServiceUtil.class,
546                                    "_service");
547                    }
548    
549                    return _service;
550            }
551    
552            /**
553             * @deprecated As of 6.2.0
554             */
555            public void setService(SocialRelationLocalService service) {
556            }
557    
558            private static SocialRelationLocalService _service;
559    }