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.portlet.announcements.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the announcements delivery local service. This utility wraps {@link com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl} 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.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl} 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 AnnouncementsDeliveryLocalService
032     * @see com.liferay.portlet.announcements.service.base.AnnouncementsDeliveryLocalServiceBaseImpl
033     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl
034     * @generated
035     */
036    public class AnnouncementsDeliveryLocalServiceUtil {
037            /**
038            * Adds the announcements delivery to the database. Also notifies the appropriate model listeners.
039            *
040            * @param announcementsDelivery the announcements delivery to add
041            * @return the announcements delivery that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery addAnnouncementsDelivery(
045                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addAnnouncementsDelivery(announcementsDelivery);
048            }
049    
050            /**
051            * Creates a new announcements delivery with the primary key. Does not add the announcements delivery to the database.
052            *
053            * @param deliveryId the primary key for the new announcements delivery
054            * @return the new announcements delivery
055            */
056            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery createAnnouncementsDelivery(
057                    long deliveryId) {
058                    return getService().createAnnouncementsDelivery(deliveryId);
059            }
060    
061            /**
062            * Deletes the announcements delivery with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param deliveryId the primary key of the announcements delivery to delete
065            * @throws PortalException if a announcements delivery with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteAnnouncementsDelivery(long deliveryId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteAnnouncementsDelivery(deliveryId);
072            }
073    
074            /**
075            * Deletes the announcements delivery from the database. Also notifies the appropriate model listeners.
076            *
077            * @param announcementsDelivery the announcements delivery to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteAnnouncementsDelivery(
081                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteAnnouncementsDelivery(announcementsDelivery);
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 announcements delivery with the primary key.
159            *
160            * @param deliveryId the primary key of the announcements delivery to get
161            * @return the announcements delivery
162            * @throws PortalException if a announcements delivery with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getAnnouncementsDelivery(
166                    long deliveryId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getAnnouncementsDelivery(deliveryId);
170            }
171    
172            /**
173            * Gets a range of all the announcements deliveries.
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 announcements deliveries to return
180            * @param end the upper bound of the range of announcements deliveries to return (not inclusive)
181            * @return the range of announcements deliveries
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> getAnnouncementsDeliveries(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getAnnouncementsDeliveries(start, end);
188            }
189    
190            /**
191            * Gets the number of announcements deliveries.
192            *
193            * @return the number of announcements deliveries
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getAnnouncementsDeliveriesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getAnnouncementsDeliveriesCount();
199            }
200    
201            /**
202            * Updates the announcements delivery in the database. Also notifies the appropriate model listeners.
203            *
204            * @param announcementsDelivery the announcements delivery to update
205            * @return the announcements delivery that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery updateAnnouncementsDelivery(
209                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateAnnouncementsDelivery(announcementsDelivery);
212            }
213    
214            /**
215            * Updates the announcements delivery in the database. Also notifies the appropriate model listeners.
216            *
217            * @param announcementsDelivery the announcements delivery to update
218            * @param merge whether to merge the announcements delivery 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 announcements delivery that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery updateAnnouncementsDelivery(
223                    com.liferay.portlet.announcements.model.AnnouncementsDelivery announcementsDelivery,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService()
227                                       .updateAnnouncementsDelivery(announcementsDelivery, merge);
228            }
229    
230            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery addUserDelivery(
231                    long userId, java.lang.String type)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException {
234                    return getService().addUserDelivery(userId, type);
235            }
236    
237            public static void deleteDeliveries(long userId)
238                    throws com.liferay.portal.kernel.exception.SystemException {
239                    getService().deleteDeliveries(userId);
240            }
241    
242            public static void deleteDelivery(long deliveryId)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException {
245                    getService().deleteDelivery(deliveryId);
246            }
247    
248            public static void deleteDelivery(long userId, java.lang.String type)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    getService().deleteDelivery(userId, type);
251            }
252    
253            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getDelivery(
254                    long deliveryId)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException {
257                    return getService().getDelivery(deliveryId);
258            }
259    
260            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> getUserDeliveries(
261                    long userId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService().getUserDeliveries(userId);
265            }
266    
267            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery getUserDelivery(
268                    long userId, java.lang.String type)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService().getUserDelivery(userId, type);
272            }
273    
274            public static com.liferay.portlet.announcements.model.AnnouncementsDelivery updateDelivery(
275                    long userId, java.lang.String type, boolean email, boolean sms,
276                    boolean website)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService().updateDelivery(userId, type, email, sms, website);
280            }
281    
282            public static AnnouncementsDeliveryLocalService getService() {
283                    if (_service == null) {
284                            _service = (AnnouncementsDeliveryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsDeliveryLocalService.class.getName());
285                    }
286    
287                    return _service;
288            }
289    
290            public void setService(AnnouncementsDeliveryLocalService service) {
291                    _service = service;
292            }
293    
294            private static AnnouncementsDeliveryLocalService _service;
295    }