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 entry local service. This utility wraps {@link com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl} 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.AnnouncementsEntryLocalServiceImpl} 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 AnnouncementsEntryLocalService
032     * @see com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl
033     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
034     * @generated
035     */
036    public class AnnouncementsEntryLocalServiceUtil {
037            /**
038            * Adds the announcements entry to the database. Also notifies the appropriate model listeners.
039            *
040            * @param announcementsEntry the announcements entry to add
041            * @return the announcements entry that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addAnnouncementsEntry(
045                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addAnnouncementsEntry(announcementsEntry);
048            }
049    
050            /**
051            * Creates a new announcements entry with the primary key. Does not add the announcements entry to the database.
052            *
053            * @param entryId the primary key for the new announcements entry
054            * @return the new announcements entry
055            */
056            public static com.liferay.portlet.announcements.model.AnnouncementsEntry createAnnouncementsEntry(
057                    long entryId) {
058                    return getService().createAnnouncementsEntry(entryId);
059            }
060    
061            /**
062            * Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param entryId the primary key of the announcements entry to delete
065            * @throws PortalException if a announcements entry with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteAnnouncementsEntry(long entryId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteAnnouncementsEntry(entryId);
072            }
073    
074            /**
075            * Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
076            *
077            * @param announcementsEntry the announcements entry to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteAnnouncementsEntry(
081                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteAnnouncementsEntry(announcementsEntry);
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 entry with the primary key.
159            *
160            * @param entryId the primary key of the announcements entry to get
161            * @return the announcements entry
162            * @throws PortalException if a announcements entry 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.AnnouncementsEntry getAnnouncementsEntry(
166                    long entryId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getAnnouncementsEntry(entryId);
170            }
171    
172            /**
173            * Gets a range of all the announcements entries.
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 entries to return
180            * @param end the upper bound of the range of announcements entries to return (not inclusive)
181            * @return the range of announcements entries
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getAnnouncementsEntries(start, end);
188            }
189    
190            /**
191            * Gets the number of announcements entries.
192            *
193            * @return the number of announcements entries
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getAnnouncementsEntriesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getAnnouncementsEntriesCount();
199            }
200    
201            /**
202            * Updates the announcements entry in the database. Also notifies the appropriate model listeners.
203            *
204            * @param announcementsEntry the announcements entry to update
205            * @return the announcements entry that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
209                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateAnnouncementsEntry(announcementsEntry);
212            }
213    
214            /**
215            * Updates the announcements entry in the database. Also notifies the appropriate model listeners.
216            *
217            * @param announcementsEntry the announcements entry to update
218            * @param merge whether to merge the announcements entry 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 entry that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
223                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updateAnnouncementsEntry(announcementsEntry, merge);
227            }
228    
229            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
230                    long userId, long classNameId, long classPK, java.lang.String title,
231                    java.lang.String content, java.lang.String url, java.lang.String type,
232                    int displayDateMonth, int displayDateDay, int displayDateYear,
233                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
234                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
235                    int expirationDateMinute, int priority, boolean alert)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException {
238                    return getService()
239                                       .addEntry(userId, classNameId, classPK, title, content, url,
240                            type, displayDateMonth, displayDateDay, displayDateYear,
241                            displayDateHour, displayDateMinute, expirationDateMonth,
242                            expirationDateDay, expirationDateYear, expirationDateHour,
243                            expirationDateMinute, priority, alert);
244            }
245    
246            public static void checkEntries()
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException {
249                    getService().checkEntries();
250            }
251    
252            public static void deleteEntry(
253                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException {
256                    getService().deleteEntry(entry);
257            }
258    
259            public static void deleteEntry(long entryId)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    getService().deleteEntry(entryId);
263            }
264    
265            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
266                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
267                    boolean alert, int flagValue, int start, int end)
268                    throws com.liferay.portal.kernel.exception.SystemException {
269                    return getService()
270                                       .getEntries(userId, scopes, alert, flagValue, start, end);
271            }
272    
273            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
274                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
275                    int displayDateMonth, int displayDateDay, int displayDateYear,
276                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
277                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
278                    int expirationDateMinute, boolean alert, int flagValue, int start,
279                    int end) throws com.liferay.portal.kernel.exception.SystemException {
280                    return getService()
281                                       .getEntries(userId, scopes, displayDateMonth,
282                            displayDateDay, displayDateYear, displayDateHour,
283                            displayDateMinute, expirationDateMonth, expirationDateDay,
284                            expirationDateYear, expirationDateHour, expirationDateMinute,
285                            alert, flagValue, start, end);
286            }
287    
288            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
289                    long classNameId, long classPK, boolean alert, int start, int end)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().getEntries(classNameId, classPK, alert, start, end);
292            }
293    
294            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
295                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
296                    int displayDateDay, int displayDateYear, int displayDateHour,
297                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
298                    int expirationDateYear, int expirationDateHour,
299                    int expirationDateMinute, boolean alert, int flagValue, int start,
300                    int end) throws com.liferay.portal.kernel.exception.SystemException {
301                    return getService()
302                                       .getEntries(userId, classNameId, classPKs, displayDateMonth,
303                            displayDateDay, displayDateYear, displayDateHour,
304                            displayDateMinute, expirationDateMonth, expirationDateDay,
305                            expirationDateYear, expirationDateHour, expirationDateMinute,
306                            alert, flagValue, start, end);
307            }
308    
309            public static int getEntriesCount(long userId,
310                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
311                    int flagValue)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService().getEntriesCount(userId, scopes, alert, flagValue);
314            }
315    
316            public static int getEntriesCount(long userId,
317                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
318                    int displayDateMonth, int displayDateDay, int displayDateYear,
319                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
320                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
321                    int expirationDateMinute, boolean alert, int flagValue)
322                    throws com.liferay.portal.kernel.exception.SystemException {
323                    return getService()
324                                       .getEntriesCount(userId, scopes, displayDateMonth,
325                            displayDateDay, displayDateYear, displayDateHour,
326                            displayDateMinute, expirationDateMonth, expirationDateDay,
327                            expirationDateYear, expirationDateHour, expirationDateMinute,
328                            alert, flagValue);
329            }
330    
331            public static int getEntriesCount(long classNameId, long classPK,
332                    boolean alert)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getEntriesCount(classNameId, classPK, alert);
335            }
336    
337            public static int getEntriesCount(long userId, long classNameId,
338                    long[] classPKs, boolean alert, int flagValue)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService()
341                                       .getEntriesCount(userId, classNameId, classPKs, alert,
342                            flagValue);
343            }
344    
345            public static int getEntriesCount(long userId, long classNameId,
346                    long[] classPKs, int displayDateMonth, int displayDateDay,
347                    int displayDateYear, int displayDateHour, int displayDateMinute,
348                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
349                    int expirationDateHour, int expirationDateMinute, boolean alert,
350                    int flagValue)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .getEntriesCount(userId, classNameId, classPKs,
354                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
355                            displayDateMinute, expirationDateMonth, expirationDateDay,
356                            expirationDateYear, expirationDateHour, expirationDateMinute,
357                            alert, flagValue);
358            }
359    
360            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
361                    long entryId)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getEntry(entryId);
365            }
366    
367            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
368                    long userId, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getUserEntries(userId, start, end);
371            }
372    
373            public static int getUserEntriesCount(long userId)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getUserEntriesCount(userId);
376            }
377    
378            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
379                    long userId, long entryId, java.lang.String title,
380                    java.lang.String content, java.lang.String url, java.lang.String type,
381                    int displayDateMonth, int displayDateDay, int displayDateYear,
382                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
383                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
384                    int expirationDateMinute, int priority)
385                    throws com.liferay.portal.kernel.exception.PortalException,
386                            com.liferay.portal.kernel.exception.SystemException {
387                    return getService()
388                                       .updateEntry(userId, entryId, title, content, url, type,
389                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
390                            displayDateMinute, expirationDateMonth, expirationDateDay,
391                            expirationDateYear, expirationDateHour, expirationDateMinute,
392                            priority);
393            }
394    
395            public static AnnouncementsEntryLocalService getService() {
396                    if (_service == null) {
397                            _service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
398                    }
399    
400                    return _service;
401            }
402    
403            public void setService(AnnouncementsEntryLocalService service) {
404                    _service = service;
405            }
406    
407            private static AnnouncementsEntryLocalService _service;
408    }