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 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.
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 SocialRelationLocalService
030     * @see com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl
031     * @see com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl
032     * @generated
033     */
034    public class SocialRelationLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the social relation to the database. Also notifies the appropriate model listeners.
043            *
044            * @param socialRelation the social relation
045            * @return the social relation that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.social.model.SocialRelation addSocialRelation(
049                    com.liferay.portlet.social.model.SocialRelation socialRelation)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addSocialRelation(socialRelation);
052            }
053    
054            /**
055            * Creates a new social relation with the primary key. Does not add the social relation to the database.
056            *
057            * @param relationId the primary key for the new social relation
058            * @return the new social relation
059            */
060            public static com.liferay.portlet.social.model.SocialRelation createSocialRelation(
061                    long relationId) {
062                    return getService().createSocialRelation(relationId);
063            }
064    
065            /**
066            * Deletes the social relation with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param relationId the primary key of the social relation
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 void deleteSocialRelation(long relationId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteSocialRelation(relationId);
076            }
077    
078            /**
079            * Deletes the social relation from the database. Also notifies the appropriate model listeners.
080            *
081            * @param socialRelation the social relation
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteSocialRelation(
085                    com.liferay.portlet.social.model.SocialRelation socialRelation)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteSocialRelation(socialRelation);
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 relation with the primary key.
163            *
164            * @param relationId the primary key of the social relation
165            * @return the social relation
166            * @throws PortalException if a social relation 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.SocialRelation getSocialRelation(
170                    long relationId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getSocialRelation(relationId);
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 a range of all the social relations.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of social relations
191            * @param end the upper bound of the range of social relations (not inclusive)
192            * @return the range of social relations
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getSocialRelations(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getSocialRelations(start, end);
199            }
200    
201            /**
202            * Returns the number of social relations.
203            *
204            * @return the number of social relations
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getSocialRelationsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getSocialRelationsCount();
210            }
211    
212            /**
213            * Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param socialRelation the social relation
216            * @return the social relation that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.social.model.SocialRelation updateSocialRelation(
220                    com.liferay.portlet.social.model.SocialRelation socialRelation)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateSocialRelation(socialRelation);
223            }
224    
225            /**
226            * Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param socialRelation the social relation
229            * @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.
230            * @return the social relation that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.social.model.SocialRelation updateSocialRelation(
234                    com.liferay.portlet.social.model.SocialRelation socialRelation,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateSocialRelation(socialRelation, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.social.model.SocialRelation addRelation(
259                    long userId1, long userId2, int type)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService().addRelation(userId1, userId2, type);
263            }
264    
265            public static void deleteRelation(long relationId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    getService().deleteRelation(relationId);
269            }
270    
271            public static void deleteRelation(long userId1, long userId2, int type)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    getService().deleteRelation(userId1, userId2, type);
275            }
276    
277            public static void deleteRelation(
278                    com.liferay.portlet.social.model.SocialRelation relation)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService().deleteRelation(relation);
282            }
283    
284            public static void deleteRelations(long userId)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteRelations(userId);
287            }
288    
289            public static void deleteRelations(long userId1, long userId2)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteRelations(userId1, userId2);
293            }
294    
295            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getInverseRelations(
296                    long userId, int type, int start, int end)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    return getService().getInverseRelations(userId, type, start, end);
299            }
300    
301            public static int getInverseRelationsCount(long userId, int type)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    return getService().getInverseRelationsCount(userId, type);
304            }
305    
306            public static com.liferay.portlet.social.model.SocialRelation getRelation(
307                    long relationId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    return getService().getRelation(relationId);
311            }
312    
313            public static com.liferay.portlet.social.model.SocialRelation getRelation(
314                    long userId1, long userId2, int type)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getRelation(userId1, userId2, type);
318            }
319    
320            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getRelations(
321                    long userId, int type, int start, int end)
322                    throws com.liferay.portal.kernel.exception.SystemException {
323                    return getService().getRelations(userId, type, start, end);
324            }
325    
326            public static java.util.List<com.liferay.portlet.social.model.SocialRelation> getRelations(
327                    long userId1, long userId2, int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    return getService().getRelations(userId1, userId2, start, end);
330            }
331    
332            public static int getRelationsCount(long userId, int type)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getRelationsCount(userId, type);
335            }
336    
337            public static int getRelationsCount(long userId1, long userId2)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getRelationsCount(userId1, userId2);
340            }
341    
342            public static boolean hasRelation(long userId1, long userId2, int type)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().hasRelation(userId1, userId2, type);
345            }
346    
347            public static boolean isRelatable(long userId1, long userId2, int type)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    return getService().isRelatable(userId1, userId2, type);
350            }
351    
352            public static SocialRelationLocalService getService() {
353                    if (_service == null) {
354                            _service = (SocialRelationLocalService)PortalBeanLocatorUtil.locate(SocialRelationLocalService.class.getName());
355    
356                            ReferenceRegistry.registerReference(SocialRelationLocalServiceUtil.class,
357                                    "_service");
358                            MethodCache.remove(SocialRelationLocalService.class);
359                    }
360    
361                    return _service;
362            }
363    
364            public void setService(SocialRelationLocalService service) {
365                    MethodCache.remove(SocialRelationLocalService.class);
366    
367                    _service = service;
368    
369                    ReferenceRegistry.registerReference(SocialRelationLocalServiceUtil.class,
370                            "_service");
371                    MethodCache.remove(SocialRelationLocalService.class);
372            }
373    
374            private static SocialRelationLocalService _service;
375    }