001    /**
002     * Copyright (c) 2000-2011 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    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see AnnouncementsEntryLocalService
030     * @see com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl
031     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
032     * @generated
033     */
034    public class AnnouncementsEntryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the announcements entry to the database. Also notifies the appropriate model listeners.
043            *
044            * @param announcementsEntry the announcements entry
045            * @return the announcements entry that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addAnnouncementsEntry(
049                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addAnnouncementsEntry(announcementsEntry);
052            }
053    
054            /**
055            * Creates a new announcements entry with the primary key. Does not add the announcements entry to the database.
056            *
057            * @param entryId the primary key for the new announcements entry
058            * @return the new announcements entry
059            */
060            public static com.liferay.portlet.announcements.model.AnnouncementsEntry createAnnouncementsEntry(
061                    long entryId) {
062                    return getService().createAnnouncementsEntry(entryId);
063            }
064    
065            /**
066            * Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param entryId the primary key of the announcements entry
069            * @throws PortalException if a announcements entry with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteAnnouncementsEntry(long entryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteAnnouncementsEntry(entryId);
076            }
077    
078            /**
079            * Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
080            *
081            * @param announcementsEntry the announcements entry
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteAnnouncementsEntry(
085                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteAnnouncementsEntry(announcementsEntry);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the announcements entry with the primary key.
163            *
164            * @param entryId the primary key of the announcements entry
165            * @return the announcements entry
166            * @throws PortalException if a announcements entry with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
170                    long entryId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getAnnouncementsEntry(entryId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the announcements entries.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of announcements entries
191            * @param end the upper bound of the range of announcements entries (not inclusive)
192            * @return the range of announcements entries
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getAnnouncementsEntries(start, end);
199            }
200    
201            /**
202            * Returns the number of announcements entries.
203            *
204            * @return the number of announcements entries
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getAnnouncementsEntriesCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getAnnouncementsEntriesCount();
210            }
211    
212            /**
213            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param announcementsEntry the announcements entry
216            * @return the announcements entry that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
220                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateAnnouncementsEntry(announcementsEntry);
223            }
224    
225            /**
226            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param announcementsEntry the announcements entry
229            * @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.
230            * @return the announcements entry that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
234                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateAnnouncementsEntry(announcementsEntry, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
259                    long userId, long classNameId, long classPK, java.lang.String title,
260                    java.lang.String content, java.lang.String url, java.lang.String type,
261                    int displayDateMonth, int displayDateDay, int displayDateYear,
262                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
263                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
264                    int expirationDateMinute, int priority, boolean alert)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService()
268                                       .addEntry(userId, classNameId, classPK, title, content, url,
269                            type, displayDateMonth, displayDateDay, displayDateYear,
270                            displayDateHour, displayDateMinute, expirationDateMonth,
271                            expirationDateDay, expirationDateYear, expirationDateHour,
272                            expirationDateMinute, priority, alert);
273            }
274    
275            public static void checkEntries()
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    getService().checkEntries();
279            }
280    
281            public static void deleteEntry(
282                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    getService().deleteEntry(entry);
286            }
287    
288            public static void deleteEntry(long entryId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteEntry(entryId);
292            }
293    
294            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
295                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
296                    boolean alert, int flagValue, int start, int end)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .getEntries(userId, scopes, alert, flagValue, start, end);
300            }
301    
302            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
303                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
304                    int displayDateMonth, int displayDateDay, int displayDateYear,
305                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
306                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
307                    int expirationDateMinute, boolean alert, int flagValue, int start,
308                    int end) throws com.liferay.portal.kernel.exception.SystemException {
309                    return getService()
310                                       .getEntries(userId, scopes, displayDateMonth,
311                            displayDateDay, displayDateYear, displayDateHour,
312                            displayDateMinute, expirationDateMonth, expirationDateDay,
313                            expirationDateYear, expirationDateHour, expirationDateMinute,
314                            alert, flagValue, start, end);
315            }
316    
317            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
318                    long classNameId, long classPK, boolean alert, int start, int end)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getEntries(classNameId, classPK, alert, start, end);
321            }
322    
323            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
324                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
325                    int displayDateDay, int displayDateYear, int displayDateHour,
326                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
327                    int expirationDateYear, int expirationDateHour,
328                    int expirationDateMinute, boolean alert, int flagValue, int start,
329                    int end) throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService()
331                                       .getEntries(userId, classNameId, classPKs, displayDateMonth,
332                            displayDateDay, displayDateYear, displayDateHour,
333                            displayDateMinute, expirationDateMonth, expirationDateDay,
334                            expirationDateYear, expirationDateHour, expirationDateMinute,
335                            alert, flagValue, start, end);
336            }
337    
338            public static int getEntriesCount(long userId,
339                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
340                    int flagValue)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getEntriesCount(userId, scopes, alert, flagValue);
343            }
344    
345            public static int getEntriesCount(long userId,
346                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
347                    int displayDateMonth, int displayDateDay, int displayDateYear,
348                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
349                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
350                    int expirationDateMinute, boolean alert, int flagValue)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .getEntriesCount(userId, scopes, displayDateMonth,
354                            displayDateDay, displayDateYear, displayDateHour,
355                            displayDateMinute, expirationDateMonth, expirationDateDay,
356                            expirationDateYear, expirationDateHour, expirationDateMinute,
357                            alert, flagValue);
358            }
359    
360            public static int getEntriesCount(long classNameId, long classPK,
361                    boolean alert)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getEntriesCount(classNameId, classPK, alert);
364            }
365    
366            public static int getEntriesCount(long userId, long classNameId,
367                    long[] classPKs, boolean alert, int flagValue)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService()
370                                       .getEntriesCount(userId, classNameId, classPKs, alert,
371                            flagValue);
372            }
373    
374            public static int getEntriesCount(long userId, long classNameId,
375                    long[] classPKs, int displayDateMonth, int displayDateDay,
376                    int displayDateYear, int displayDateHour, int displayDateMinute,
377                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
378                    int expirationDateHour, int expirationDateMinute, boolean alert,
379                    int flagValue)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService()
382                                       .getEntriesCount(userId, classNameId, classPKs,
383                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
384                            displayDateMinute, expirationDateMonth, expirationDateDay,
385                            expirationDateYear, expirationDateHour, expirationDateMinute,
386                            alert, flagValue);
387            }
388    
389            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
390                    long entryId)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getEntry(entryId);
394            }
395    
396            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
397                    long userId, int start, int end)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getUserEntries(userId, start, end);
400            }
401    
402            public static int getUserEntriesCount(long userId)
403                    throws com.liferay.portal.kernel.exception.SystemException {
404                    return getService().getUserEntriesCount(userId);
405            }
406    
407            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
408                    long userId, long entryId, java.lang.String title,
409                    java.lang.String content, java.lang.String url, java.lang.String type,
410                    int displayDateMonth, int displayDateDay, int displayDateYear,
411                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
412                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
413                    int expirationDateMinute, int priority)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException {
416                    return getService()
417                                       .updateEntry(userId, entryId, title, content, url, type,
418                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
419                            displayDateMinute, expirationDateMonth, expirationDateDay,
420                            expirationDateYear, expirationDateHour, expirationDateMinute,
421                            priority);
422            }
423    
424            public static AnnouncementsEntryLocalService getService() {
425                    if (_service == null) {
426                            _service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
427    
428                            ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
429                                    "_service");
430                            MethodCache.remove(AnnouncementsEntryLocalService.class);
431                    }
432    
433                    return _service;
434            }
435    
436            public void setService(AnnouncementsEntryLocalService service) {
437                    MethodCache.remove(AnnouncementsEntryLocalService.class);
438    
439                    _service = service;
440    
441                    ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
442                            "_service");
443                    MethodCache.remove(AnnouncementsEntryLocalService.class);
444            }
445    
446            private static AnnouncementsEntryLocalService _service;
447    }