001    /**
002     * Copyright (c) 2000-2012 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.portal.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 subscription local service. This utility wraps {@link com.liferay.portal.service.impl.SubscriptionLocalServiceImpl} 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 SubscriptionLocalService
030     * @see com.liferay.portal.service.base.SubscriptionLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.SubscriptionLocalServiceImpl
032     * @generated
033     */
034    public class SubscriptionLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.SubscriptionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the subscription to the database. Also notifies the appropriate model listeners.
043            *
044            * @param subscription the subscription
045            * @return the subscription that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.Subscription addSubscription(
049                    com.liferay.portal.model.Subscription subscription)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addSubscription(subscription);
052            }
053    
054            /**
055            * Creates a new subscription with the primary key. Does not add the subscription to the database.
056            *
057            * @param subscriptionId the primary key for the new subscription
058            * @return the new subscription
059            */
060            public static com.liferay.portal.model.Subscription createSubscription(
061                    long subscriptionId) {
062                    return getService().createSubscription(subscriptionId);
063            }
064    
065            /**
066            * Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param subscriptionId the primary key of the subscription
069            * @throws PortalException if a subscription with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteSubscription(long subscriptionId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteSubscription(subscriptionId);
076            }
077    
078            /**
079            * Deletes the subscription from the database. Also notifies the appropriate model listeners.
080            *
081            * @param subscription the subscription
082            * @throws PortalException
083            * @throws SystemException if a system exception occurred
084            */
085            public static void deleteSubscription(
086                    com.liferay.portal.model.Subscription subscription)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException {
089                    getService().deleteSubscription(subscription);
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public static java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException {
103                    return getService().dynamicQuery(dynamicQuery);
104            }
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public static java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException {
123                    return getService().dynamicQuery(dynamicQuery, start, end);
124            }
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public static java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException {
146                    return getService()
147                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
148            }
149    
150            /**
151            * Returns the number of rows that match the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows that match the dynamic query
155            * @throws SystemException if a system exception occurred
156            */
157            public static long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
159                    throws com.liferay.portal.kernel.exception.SystemException {
160                    return getService().dynamicQueryCount(dynamicQuery);
161            }
162    
163            public static com.liferay.portal.model.Subscription fetchSubscription(
164                    long subscriptionId)
165                    throws com.liferay.portal.kernel.exception.SystemException {
166                    return getService().fetchSubscription(subscriptionId);
167            }
168    
169            /**
170            * Returns the subscription with the primary key.
171            *
172            * @param subscriptionId the primary key of the subscription
173            * @return the subscription
174            * @throws PortalException if a subscription with the primary key could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            public static com.liferay.portal.model.Subscription getSubscription(
178                    long subscriptionId)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException {
181                    return getService().getSubscription(subscriptionId);
182            }
183    
184            public static com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException {
188                    return getService().getPersistedModel(primaryKeyObj);
189            }
190    
191            /**
192            * Returns a range of all the subscriptions.
193            *
194            * <p>
195            * 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of subscriptions
199            * @param end the upper bound of the range of subscriptions (not inclusive)
200            * @return the range of subscriptions
201            * @throws SystemException if a system exception occurred
202            */
203            public static java.util.List<com.liferay.portal.model.Subscription> getSubscriptions(
204                    int start, int end)
205                    throws com.liferay.portal.kernel.exception.SystemException {
206                    return getService().getSubscriptions(start, end);
207            }
208    
209            /**
210            * Returns the number of subscriptions.
211            *
212            * @return the number of subscriptions
213            * @throws SystemException if a system exception occurred
214            */
215            public static int getSubscriptionsCount()
216                    throws com.liferay.portal.kernel.exception.SystemException {
217                    return getService().getSubscriptionsCount();
218            }
219    
220            /**
221            * Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
222            *
223            * @param subscription the subscription
224            * @return the subscription that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public static com.liferay.portal.model.Subscription updateSubscription(
228                    com.liferay.portal.model.Subscription subscription)
229                    throws com.liferay.portal.kernel.exception.SystemException {
230                    return getService().updateSubscription(subscription);
231            }
232    
233            /**
234            * Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
235            *
236            * @param subscription the subscription
237            * @param merge whether to merge the subscription 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.
238            * @return the subscription that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portal.model.Subscription updateSubscription(
242                    com.liferay.portal.model.Subscription subscription, boolean merge)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateSubscription(subscription, merge);
245            }
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public static java.lang.String getBeanIdentifier() {
253                    return getService().getBeanIdentifier();
254            }
255    
256            /**
257            * Sets the Spring bean ID for this bean.
258            *
259            * @param beanIdentifier the Spring bean ID for this bean
260            */
261            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
262                    getService().setBeanIdentifier(beanIdentifier);
263            }
264    
265            public static com.liferay.portal.model.Subscription addSubscription(
266                    long userId, long groupId, java.lang.String className, long classPK)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    return getService().addSubscription(userId, groupId, className, classPK);
270            }
271    
272            public static com.liferay.portal.model.Subscription addSubscription(
273                    long userId, long groupId, java.lang.String className, long classPK,
274                    java.lang.String frequency)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addSubscription(userId, groupId, className, classPK,
279                            frequency);
280            }
281    
282            public static void deleteSubscription(long userId,
283                    java.lang.String className, long classPK)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteSubscription(userId, className, classPK);
287            }
288    
289            public static void deleteSubscriptions(long userId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteSubscriptions(userId);
293            }
294    
295            public static void deleteSubscriptions(long companyId,
296                    java.lang.String className, long classPK)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteSubscriptions(companyId, className, classPK);
300            }
301    
302            public static com.liferay.portal.model.Subscription getSubscription(
303                    long companyId, long userId, java.lang.String className, long classPK)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService()
307                                       .getSubscription(companyId, userId, className, classPK);
308            }
309    
310            public static java.util.List<com.liferay.portal.model.Subscription> getSubscriptions(
311                    long companyId, java.lang.String className, long classPK)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService().getSubscriptions(companyId, className, classPK);
314            }
315    
316            public static java.util.List<com.liferay.portal.model.Subscription> getUserSubscriptions(
317                    long userId, int start, int end,
318                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService()
321                                       .getUserSubscriptions(userId, start, end, orderByComparator);
322            }
323    
324            public static java.util.List<com.liferay.portal.model.Subscription> getUserSubscriptions(
325                    long userId, java.lang.String className)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getUserSubscriptions(userId, className);
328            }
329    
330            public static int getUserSubscriptionsCount(long userId)
331                    throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getUserSubscriptionsCount(userId);
333            }
334    
335            public static boolean isSubscribed(long companyId, long userId,
336                    java.lang.String className, long classPK)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().isSubscribed(companyId, userId, className, classPK);
339            }
340    
341            public static SubscriptionLocalService getService() {
342                    if (_service == null) {
343                            _service = (SubscriptionLocalService)PortalBeanLocatorUtil.locate(SubscriptionLocalService.class.getName());
344    
345                            ReferenceRegistry.registerReference(SubscriptionLocalServiceUtil.class,
346                                    "_service");
347                            MethodCache.remove(SubscriptionLocalService.class);
348                    }
349    
350                    return _service;
351            }
352    
353            public void setService(SubscriptionLocalService service) {
354                    MethodCache.remove(SubscriptionLocalService.class);
355    
356                    _service = service;
357    
358                    ReferenceRegistry.registerReference(SubscriptionLocalServiceUtil.class,
359                            "_service");
360                    MethodCache.remove(SubscriptionLocalService.class);
361            }
362    
363            private static SubscriptionLocalService _service;
364    }