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.announcements.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for AnnouncementsDelivery. This utility wraps
024     * {@link com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see AnnouncementsDeliveryLocalService
032     * @see com.liferay.portlet.announcements.service.base.AnnouncementsDeliveryLocalServiceBaseImpl
033     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class AnnouncementsDeliveryLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the announcements delivery to the database. Also notifies the appropriate model listeners.
046            *
047            * @param announcementsDelivery the announcements delivery
048            * @return the announcements delivery that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery addAnnouncementsDelivery(
052                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addAnnouncementsDelivery(announcementsDelivery);
055            }
056    
057            /**
058            * Creates a new announcements delivery with the primary key. Does not add the announcements delivery to the database.
059            *
060            * @param deliveryId the primary key for the new announcements delivery
061            * @return the new announcements delivery
062            */
063            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery createAnnouncementsDelivery(
064                    long deliveryId) {
065                    return getService().createAnnouncementsDelivery(deliveryId);
066            }
067    
068            /**
069            * Deletes the announcements delivery with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param deliveryId the primary key of the announcements delivery
072            * @return the announcements delivery that was removed
073            * @throws PortalException if a announcements delivery with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery deleteAnnouncementsDelivery(
077                    long deliveryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteAnnouncementsDelivery(deliveryId);
081            }
082    
083            /**
084            * Deletes the announcements delivery from the database. Also notifies the appropriate model listeners.
085            *
086            * @param announcementsDelivery the announcements delivery
087            * @return the announcements delivery that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery deleteAnnouncementsDelivery(
091                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteAnnouncementsDelivery(announcementsDelivery);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.announcements.model.impl.AnnouncementsDeliveryModelImpl}. 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.announcements.model.impl.AnnouncementsDeliveryModelImpl}. 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery fetchAnnouncementsDelivery(
187                    long deliveryId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchAnnouncementsDelivery(deliveryId);
190            }
191    
192            /**
193            * Returns the announcements delivery with the primary key.
194            *
195            * @param deliveryId the primary key of the announcements delivery
196            * @return the announcements delivery
197            * @throws PortalException if a announcements delivery with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getAnnouncementsDelivery(
201                    long deliveryId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getAnnouncementsDelivery(deliveryId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the announcements deliveries.
216            *
217            * <p>
218            * 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.announcements.model.impl.AnnouncementsDeliveryModelImpl}. 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of announcements deliveries
222            * @param end the upper bound of the range of announcements deliveries (not inclusive)
223            * @return the range of announcements deliveries
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> getAnnouncementsDeliveries(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getAnnouncementsDeliveries(start, end);
230            }
231    
232            /**
233            * Returns the number of announcements deliveries.
234            *
235            * @return the number of announcements deliveries
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getAnnouncementsDeliveriesCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getAnnouncementsDeliveriesCount();
241            }
242    
243            /**
244            * Updates the announcements delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param announcementsDelivery the announcements delivery
247            * @return the announcements delivery that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery updateAnnouncementsDelivery(
251                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateAnnouncementsDelivery(announcementsDelivery);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery addUserDelivery(
275                    long userId, java.lang.String type)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    return getService().addUserDelivery(userId, type);
279            }
280    
281            public static void deleteDeliveries(long userId)
282                    throws com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteDeliveries(userId);
284            }
285    
286            public static void deleteDelivery(
287                    com.liferay.portlet.announcements.model.AnnouncementsDelivery delivery)
288                    throws com.liferay.portal.kernel.exception.SystemException {
289                    getService().deleteDelivery(delivery);
290            }
291    
292            public static void deleteDelivery(long deliveryId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService().deleteDelivery(deliveryId);
296            }
297    
298            public static void deleteDelivery(long userId, java.lang.String type)
299                    throws com.liferay.portal.kernel.exception.SystemException {
300                    getService().deleteDelivery(userId, type);
301            }
302    
303            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getDelivery(
304                    long deliveryId)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    return getService().getDelivery(deliveryId);
308            }
309    
310            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> getUserDeliveries(
311                    long userId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    return getService().getUserDeliveries(userId);
315            }
316    
317            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getUserDelivery(
318                    long userId, java.lang.String type)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    return getService().getUserDelivery(userId, type);
322            }
323    
324            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery updateDelivery(
325                    long userId, java.lang.String type, boolean email, boolean sms,
326                    boolean website)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    return getService().updateDelivery(userId, type, email, sms, website);
330            }
331    
332            public static AnnouncementsDeliveryLocalService getService() {
333                    if (_service == null) {
334                            _service = (AnnouncementsDeliveryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsDeliveryLocalService.class.getName());
335    
336                            ReferenceRegistry.registerReference(AnnouncementsDeliveryLocalServiceUtil.class,
337                                    "_service");
338                    }
339    
340                    return _service;
341            }
342    
343            /**
344             * @deprecated As of 6.2.0
345             */
346            public void setService(AnnouncementsDeliveryLocalService service) {
347            }
348    
349            private static AnnouncementsDeliveryLocalService _service;
350    }