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.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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
256                    long userId, long classNameId, long classPK, java.lang.String title,
257                    java.lang.String content, java.lang.String url, java.lang.String type,
258                    int displayDateMonth, int displayDateDay, int displayDateYear,
259                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
260                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
261                    int expirationDateMinute, int priority, boolean alert)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService()
265                                       .addEntry(userId, classNameId, classPK, title, content, url,
266                            type, displayDateMonth, displayDateDay, displayDateYear,
267                            displayDateHour, displayDateMinute, expirationDateMonth,
268                            expirationDateDay, expirationDateYear, expirationDateHour,
269                            expirationDateMinute, priority, alert);
270            }
271    
272            public static void checkEntries()
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    getService().checkEntries();
276            }
277    
278            public static void deleteEntry(
279                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService().deleteEntry(entry);
283            }
284    
285            public static void deleteEntry(long entryId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteEntry(entryId);
289            }
290    
291            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
292                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
293                    boolean alert, int flagValue, int start, int end)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService()
296                                       .getEntries(userId, scopes, alert, flagValue, start, end);
297            }
298    
299            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
300                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
301                    int displayDateMonth, int displayDateDay, int displayDateYear,
302                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
303                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
304                    int expirationDateMinute, boolean alert, int flagValue, int start,
305                    int end) throws com.liferay.portal.kernel.exception.SystemException {
306                    return getService()
307                                       .getEntries(userId, scopes, displayDateMonth,
308                            displayDateDay, displayDateYear, displayDateHour,
309                            displayDateMinute, expirationDateMonth, expirationDateDay,
310                            expirationDateYear, expirationDateHour, expirationDateMinute,
311                            alert, flagValue, start, end);
312            }
313    
314            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
315                    long classNameId, long classPK, boolean alert, int start, int end)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getEntries(classNameId, classPK, alert, start, end);
318            }
319    
320            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
321                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
322                    int displayDateDay, int displayDateYear, int displayDateHour,
323                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
324                    int expirationDateYear, int expirationDateHour,
325                    int expirationDateMinute, boolean alert, int flagValue, int start,
326                    int end) throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService()
328                                       .getEntries(userId, classNameId, classPKs, displayDateMonth,
329                            displayDateDay, displayDateYear, displayDateHour,
330                            displayDateMinute, expirationDateMonth, expirationDateDay,
331                            expirationDateYear, expirationDateHour, expirationDateMinute,
332                            alert, flagValue, start, end);
333            }
334    
335            public static int getEntriesCount(long userId,
336                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
337                    int flagValue)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getEntriesCount(userId, scopes, alert, flagValue);
340            }
341    
342            public static int getEntriesCount(long userId,
343                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
344                    int displayDateMonth, int displayDateDay, int displayDateYear,
345                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
346                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
347                    int expirationDateMinute, boolean alert, int flagValue)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    return getService()
350                                       .getEntriesCount(userId, scopes, displayDateMonth,
351                            displayDateDay, displayDateYear, displayDateHour,
352                            displayDateMinute, expirationDateMonth, expirationDateDay,
353                            expirationDateYear, expirationDateHour, expirationDateMinute,
354                            alert, flagValue);
355            }
356    
357            public static int getEntriesCount(long classNameId, long classPK,
358                    boolean alert)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getEntriesCount(classNameId, classPK, alert);
361            }
362    
363            public static int getEntriesCount(long userId, long classNameId,
364                    long[] classPKs, boolean alert, int flagValue)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService()
367                                       .getEntriesCount(userId, classNameId, classPKs, alert,
368                            flagValue);
369            }
370    
371            public static int getEntriesCount(long userId, long classNameId,
372                    long[] classPKs, int displayDateMonth, int displayDateDay,
373                    int displayDateYear, int displayDateHour, int displayDateMinute,
374                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
375                    int expirationDateHour, int expirationDateMinute, boolean alert,
376                    int flagValue)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService()
379                                       .getEntriesCount(userId, classNameId, classPKs,
380                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
381                            displayDateMinute, expirationDateMonth, expirationDateDay,
382                            expirationDateYear, expirationDateHour, expirationDateMinute,
383                            alert, flagValue);
384            }
385    
386            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
387                    long entryId)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getEntry(entryId);
391            }
392    
393            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
394                    long userId, int start, int end)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getUserEntries(userId, start, end);
397            }
398    
399            public static int getUserEntriesCount(long userId)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getUserEntriesCount(userId);
402            }
403    
404            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
405                    long userId, long entryId, java.lang.String title,
406                    java.lang.String content, java.lang.String url, java.lang.String type,
407                    int displayDateMonth, int displayDateDay, int displayDateYear,
408                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
409                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
410                    int expirationDateMinute, int priority)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    return getService()
414                                       .updateEntry(userId, entryId, title, content, url, type,
415                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
416                            displayDateMinute, expirationDateMonth, expirationDateDay,
417                            expirationDateYear, expirationDateHour, expirationDateMinute,
418                            priority);
419            }
420    
421            public static AnnouncementsEntryLocalService getService() {
422                    if (_service == null) {
423                            _service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
424    
425                            ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
426                                    "_service");
427                    }
428    
429                    return _service;
430            }
431    
432            /**
433             * @deprecated
434             */
435            public void setService(AnnouncementsEntryLocalService service) {
436            }
437    
438            private static AnnouncementsEntryLocalService _service;
439    }