001    /**
002     * Copyright (c) 2000-2012 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            public static com.liferay.portlet.announcements.model.AnnouncementsEntry fetchAnnouncementsEntry(
162                    long entryId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchAnnouncementsEntry(entryId);
165            }
166    
167            /**
168            * Returns the announcements entry with the primary key.
169            *
170            * @param entryId the primary key of the announcements entry
171            * @return the announcements entry
172            * @throws PortalException if a announcements entry with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
176                    long entryId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getAnnouncementsEntry(entryId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the announcements entries.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of announcements entries
197            * @param end the upper bound of the range of announcements entries (not inclusive)
198            * @return the range of announcements entries
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getAnnouncementsEntries(start, end);
205            }
206    
207            /**
208            * Returns the number of announcements entries.
209            *
210            * @return the number of announcements entries
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getAnnouncementsEntriesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getAnnouncementsEntriesCount();
216            }
217    
218            /**
219            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param announcementsEntry the announcements entry
222            * @return the announcements entry that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
226                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateAnnouncementsEntry(announcementsEntry);
229            }
230    
231            /**
232            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param announcementsEntry the announcements entry
235            * @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.
236            * @return the announcements entry that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
240                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updateAnnouncementsEntry(announcementsEntry, merge);
244            }
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public static java.lang.String getBeanIdentifier() {
252                    return getService().getBeanIdentifier();
253            }
254    
255            /**
256            * Sets the Spring bean ID for this bean.
257            *
258            * @param beanIdentifier the Spring bean ID for this bean
259            */
260            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
261                    getService().setBeanIdentifier(beanIdentifier);
262            }
263    
264            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
265                    long userId, long classNameId, long classPK, java.lang.String title,
266                    java.lang.String content, java.lang.String url, java.lang.String type,
267                    int displayDateMonth, int displayDateDay, int displayDateYear,
268                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
269                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
270                    int expirationDateMinute, int priority, boolean alert)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    return getService()
274                                       .addEntry(userId, classNameId, classPK, title, content, url,
275                            type, displayDateMonth, displayDateDay, displayDateYear,
276                            displayDateHour, displayDateMinute, expirationDateMonth,
277                            expirationDateDay, expirationDateYear, expirationDateHour,
278                            expirationDateMinute, priority, alert);
279            }
280    
281            public static void checkEntries()
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    getService().checkEntries();
285            }
286    
287            public static void deleteEntry(
288                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteEntry(entry);
292            }
293    
294            public static void deleteEntry(long entryId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteEntry(entryId);
298            }
299    
300            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
301                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
302                    boolean alert, int flagValue, int start, int end)
303                    throws com.liferay.portal.kernel.exception.SystemException {
304                    return getService()
305                                       .getEntries(userId, scopes, alert, flagValue, start, end);
306            }
307    
308            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
309                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
310                    int displayDateMonth, int displayDateDay, int displayDateYear,
311                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
312                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
313                    int expirationDateMinute, boolean alert, int flagValue, int start,
314                    int end) throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService()
316                                       .getEntries(userId, scopes, displayDateMonth,
317                            displayDateDay, displayDateYear, displayDateHour,
318                            displayDateMinute, expirationDateMonth, expirationDateDay,
319                            expirationDateYear, expirationDateHour, expirationDateMinute,
320                            alert, flagValue, start, end);
321            }
322    
323            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
324                    long classNameId, long classPK, boolean alert, int start, int end)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getEntries(classNameId, classPK, alert, start, end);
327            }
328    
329            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
330                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
331                    int displayDateDay, int displayDateYear, int displayDateHour,
332                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
333                    int expirationDateYear, int expirationDateHour,
334                    int expirationDateMinute, boolean alert, int flagValue, int start,
335                    int end) throws com.liferay.portal.kernel.exception.SystemException {
336                    return getService()
337                                       .getEntries(userId, classNameId, classPKs, displayDateMonth,
338                            displayDateDay, displayDateYear, displayDateHour,
339                            displayDateMinute, expirationDateMonth, expirationDateDay,
340                            expirationDateYear, expirationDateHour, expirationDateMinute,
341                            alert, flagValue, start, end);
342            }
343    
344            public static int getEntriesCount(long userId,
345                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
346                    int flagValue)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getEntriesCount(userId, scopes, alert, flagValue);
349            }
350    
351            public static int getEntriesCount(long userId,
352                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
353                    int displayDateMonth, int displayDateDay, int displayDateYear,
354                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
355                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
356                    int expirationDateMinute, boolean alert, int flagValue)
357                    throws com.liferay.portal.kernel.exception.SystemException {
358                    return getService()
359                                       .getEntriesCount(userId, scopes, displayDateMonth,
360                            displayDateDay, displayDateYear, displayDateHour,
361                            displayDateMinute, expirationDateMonth, expirationDateDay,
362                            expirationDateYear, expirationDateHour, expirationDateMinute,
363                            alert, flagValue);
364            }
365    
366            public static int getEntriesCount(long classNameId, long classPK,
367                    boolean alert)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getEntriesCount(classNameId, classPK, alert);
370            }
371    
372            public static int getEntriesCount(long userId, long classNameId,
373                    long[] classPKs, boolean alert, int flagValue)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService()
376                                       .getEntriesCount(userId, classNameId, classPKs, alert,
377                            flagValue);
378            }
379    
380            public static int getEntriesCount(long userId, long classNameId,
381                    long[] classPKs, int displayDateMonth, int displayDateDay,
382                    int displayDateYear, int displayDateHour, int displayDateMinute,
383                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
384                    int expirationDateHour, int expirationDateMinute, boolean alert,
385                    int flagValue)
386                    throws com.liferay.portal.kernel.exception.SystemException {
387                    return getService()
388                                       .getEntriesCount(userId, classNameId, classPKs,
389                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
390                            displayDateMinute, expirationDateMonth, expirationDateDay,
391                            expirationDateYear, expirationDateHour, expirationDateMinute,
392                            alert, flagValue);
393            }
394    
395            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
396                    long entryId)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getEntry(entryId);
400            }
401    
402            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
403                    long userId, int start, int end)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getUserEntries(userId, start, end);
406            }
407    
408            public static int getUserEntriesCount(long userId)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getUserEntriesCount(userId);
411            }
412    
413            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
414                    long userId, long entryId, java.lang.String title,
415                    java.lang.String content, java.lang.String url, java.lang.String type,
416                    int displayDateMonth, int displayDateDay, int displayDateYear,
417                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
418                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
419                    int expirationDateMinute, int priority)
420                    throws com.liferay.portal.kernel.exception.PortalException,
421                            com.liferay.portal.kernel.exception.SystemException {
422                    return getService()
423                                       .updateEntry(userId, entryId, title, content, url, type,
424                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
425                            displayDateMinute, expirationDateMonth, expirationDateDay,
426                            expirationDateYear, expirationDateHour, expirationDateMinute,
427                            priority);
428            }
429    
430            public static AnnouncementsEntryLocalService getService() {
431                    if (_service == null) {
432                            _service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
433    
434                            ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
435                                    "_service");
436                            MethodCache.remove(AnnouncementsEntryLocalService.class);
437                    }
438    
439                    return _service;
440            }
441    
442            public void setService(AnnouncementsEntryLocalService service) {
443                    MethodCache.remove(AnnouncementsEntryLocalService.class);
444    
445                    _service = service;
446    
447                    ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
448                            "_service");
449                    MethodCache.remove(AnnouncementsEntryLocalService.class);
450            }
451    
452            private static AnnouncementsEntryLocalService _service;
453    }