001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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, int expirationDateMonth,
275                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
276                    int expirationDateMinute, int priority, boolean alert)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addEntry(userId, classNameId, classPK, title, content, url,
281                            type, displayDateMonth, displayDateDay, displayDateYear,
282                            displayDateHour, displayDateMinute, expirationDateMonth,
283                            expirationDateDay, expirationDateYear, expirationDateHour,
284                            expirationDateMinute, priority, alert);
285            }
286    
287            public static void checkEntries()
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService().checkEntries();
291            }
292    
293            public static void deleteEntry(
294                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteEntry(entry);
298            }
299    
300            public static void deleteEntry(long entryId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteEntry(entryId);
304            }
305    
306            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
307                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
308                    boolean alert, int flagValue, int start, int end)
309                    throws com.liferay.portal.kernel.exception.SystemException {
310                    return getService()
311                                       .getEntries(userId, scopes, alert, flagValue, start, end);
312            }
313    
314            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
315                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
316                    int displayDateMonth, int displayDateDay, int displayDateYear,
317                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
318                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
319                    int expirationDateMinute, boolean alert, int flagValue, int start,
320                    int end) throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService()
322                                       .getEntries(userId, scopes, displayDateMonth,
323                            displayDateDay, displayDateYear, displayDateHour,
324                            displayDateMinute, expirationDateMonth, expirationDateDay,
325                            expirationDateYear, expirationDateHour, expirationDateMinute,
326                            alert, flagValue, start, end);
327            }
328    
329            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
330                    long classNameId, long classPK, boolean alert, int start, int end)
331                    throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getEntries(classNameId, classPK, alert, start, end);
333            }
334    
335            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
336                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
337                    int displayDateDay, int displayDateYear, int displayDateHour,
338                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
339                    int expirationDateYear, int expirationDateHour,
340                    int expirationDateMinute, boolean alert, int flagValue, int start,
341                    int end) throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService()
343                                       .getEntries(userId, classNameId, classPKs, displayDateMonth,
344                            displayDateDay, displayDateYear, displayDateHour,
345                            displayDateMinute, expirationDateMonth, expirationDateDay,
346                            expirationDateYear, expirationDateHour, expirationDateMinute,
347                            alert, flagValue, start, end);
348            }
349    
350            public static int getEntriesCount(long userId,
351                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
352                    int flagValue)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getEntriesCount(userId, scopes, alert, flagValue);
355            }
356    
357            public static int getEntriesCount(long userId,
358                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
359                    int displayDateMonth, int displayDateDay, int displayDateYear,
360                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
361                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
362                    int expirationDateMinute, boolean alert, int flagValue)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService()
365                                       .getEntriesCount(userId, scopes, displayDateMonth,
366                            displayDateDay, displayDateYear, displayDateHour,
367                            displayDateMinute, expirationDateMonth, expirationDateDay,
368                            expirationDateYear, expirationDateHour, expirationDateMinute,
369                            alert, flagValue);
370            }
371    
372            public static int getEntriesCount(long classNameId, long classPK,
373                    boolean alert)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getEntriesCount(classNameId, classPK, alert);
376            }
377    
378            public static int getEntriesCount(long userId, long classNameId,
379                    long[] classPKs, boolean alert, int flagValue)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService()
382                                       .getEntriesCount(userId, classNameId, classPKs, alert,
383                            flagValue);
384            }
385    
386            public static int getEntriesCount(long userId, long classNameId,
387                    long[] classPKs, int displayDateMonth, int displayDateDay,
388                    int displayDateYear, int displayDateHour, int displayDateMinute,
389                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
390                    int expirationDateHour, int expirationDateMinute, boolean alert,
391                    int flagValue)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService()
394                                       .getEntriesCount(userId, classNameId, classPKs,
395                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
396                            displayDateMinute, expirationDateMonth, expirationDateDay,
397                            expirationDateYear, expirationDateHour, expirationDateMinute,
398                            alert, flagValue);
399            }
400    
401            public static com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
402                    long entryId)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getEntry(entryId);
406            }
407    
408            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
409                    long userId, int start, int end)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getUserEntries(userId, start, end);
412            }
413    
414            public static int getUserEntriesCount(long userId)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getUserEntriesCount(userId);
417            }
418    
419            public static com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
420                    long userId, long entryId, java.lang.String title,
421                    java.lang.String content, java.lang.String url, java.lang.String type,
422                    int displayDateMonth, int displayDateDay, int displayDateYear,
423                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
424                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
425                    int expirationDateMinute, int priority)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    return getService()
429                                       .updateEntry(userId, entryId, title, content, url, type,
430                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
431                            displayDateMinute, expirationDateMonth, expirationDateDay,
432                            expirationDateYear, expirationDateHour, expirationDateMinute,
433                            priority);
434            }
435    
436            public static AnnouncementsEntryLocalService getService() {
437                    if (_service == null) {
438                            _service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
439    
440                            ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
441                                    "_service");
442                    }
443    
444                    return _service;
445            }
446    
447            /**
448             * @deprecated
449             */
450            public void setService(AnnouncementsEntryLocalService service) {
451            }
452    
453            private static AnnouncementsEntryLocalService _service;
454    }