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