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