001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * 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.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.SubscriptionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see SubscriptionLocalService
032     * @see com.liferay.portal.service.base.SubscriptionLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.SubscriptionLocalServiceImpl
034     * @generated
035     */
036    public class SubscriptionLocalServiceUtil {
037            /**
038            * Adds the subscription to the database. Also notifies the appropriate model listeners.
039            *
040            * @param subscription the subscription to add
041            * @return the subscription that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.Subscription addSubscription(
045                    com.liferay.portal.model.Subscription subscription)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addSubscription(subscription);
048            }
049    
050            /**
051            * Creates a new subscription with the primary key. Does not add the subscription to the database.
052            *
053            * @param subscriptionId the primary key for the new subscription
054            * @return the new subscription
055            */
056            public static com.liferay.portal.model.Subscription createSubscription(
057                    long subscriptionId) {
058                    return getService().createSubscription(subscriptionId);
059            }
060    
061            /**
062            * Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param subscriptionId the primary key of the subscription to delete
065            * @throws PortalException if a subscription with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteSubscription(long subscriptionId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteSubscription(subscriptionId);
072            }
073    
074            /**
075            * Deletes the subscription from the database. Also notifies the appropriate model listeners.
076            *
077            * @param subscription the subscription to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteSubscription(
081                    com.liferay.portal.model.Subscription subscription)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteSubscription(subscription);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the subscription with the primary key.
159            *
160            * @param subscriptionId the primary key of the subscription to get
161            * @return the subscription
162            * @throws PortalException if a subscription with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.Subscription getSubscription(
166                    long subscriptionId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getSubscription(subscriptionId);
170            }
171    
172            /**
173            * Gets a range of all the subscriptions.
174            *
175            * <p>
176            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
177            * </p>
178            *
179            * @param start the lower bound of the range of subscriptions to return
180            * @param end the upper bound of the range of subscriptions to return (not inclusive)
181            * @return the range of subscriptions
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.Subscription> getSubscriptions(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getSubscriptions(start, end);
188            }
189    
190            /**
191            * Gets the number of subscriptions.
192            *
193            * @return the number of subscriptions
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getSubscriptionsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getSubscriptionsCount();
199            }
200    
201            /**
202            * Updates the subscription in the database. Also notifies the appropriate model listeners.
203            *
204            * @param subscription the subscription to update
205            * @return the subscription that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.Subscription updateSubscription(
209                    com.liferay.portal.model.Subscription subscription)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateSubscription(subscription);
212            }
213    
214            /**
215            * Updates the subscription in the database. Also notifies the appropriate model listeners.
216            *
217            * @param subscription the subscription to update
218            * @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.
219            * @return the subscription that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.Subscription updateSubscription(
223                    com.liferay.portal.model.Subscription subscription, boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().updateSubscription(subscription, merge);
226            }
227    
228            public static com.liferay.portal.model.Subscription addSubscription(
229                    long userId, java.lang.String className, long classPK)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException {
232                    return getService().addSubscription(userId, className, classPK);
233            }
234    
235            public static com.liferay.portal.model.Subscription addSubscription(
236                    long userId, java.lang.String className, long classPK,
237                    java.lang.String frequency)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException {
240                    return getService()
241                                       .addSubscription(userId, className, classPK, frequency);
242            }
243    
244            public static void deleteSubscription(long userId,
245                    java.lang.String className, long classPK)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    getService().deleteSubscription(userId, className, classPK);
249            }
250    
251            public static void deleteSubscriptions(long userId)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    getService().deleteSubscriptions(userId);
254            }
255    
256            public static void deleteSubscriptions(long companyId,
257                    java.lang.String className, long classPK)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    getService().deleteSubscriptions(companyId, className, classPK);
260            }
261    
262            public static com.liferay.portal.model.Subscription getSubscription(
263                    long companyId, long userId, java.lang.String className, long classPK)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    return getService()
267                                       .getSubscription(companyId, userId, className, classPK);
268            }
269    
270            public static java.util.List<com.liferay.portal.model.Subscription> getSubscriptions(
271                    long companyId, java.lang.String className, long classPK)
272                    throws com.liferay.portal.kernel.exception.SystemException {
273                    return getService().getSubscriptions(companyId, className, classPK);
274            }
275    
276            public static java.util.List<com.liferay.portal.model.Subscription> getUserSubscriptions(
277                    long userId, java.lang.String className)
278                    throws com.liferay.portal.kernel.exception.SystemException {
279                    return getService().getUserSubscriptions(userId, className);
280            }
281    
282            public static boolean isSubscribed(long companyId, long userId,
283                    java.lang.String className, long classPK)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().isSubscribed(companyId, userId, className, classPK);
286            }
287    
288            public static SubscriptionLocalService getService() {
289                    if (_service == null) {
290                            _service = (SubscriptionLocalService)PortalBeanLocatorUtil.locate(SubscriptionLocalService.class.getName());
291                    }
292    
293                    return _service;
294            }
295    
296            public void setService(SubscriptionLocalService service) {
297                    _service = service;
298            }
299    
300            private static SubscriptionLocalService _service;
301    }