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.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * Provides the local service utility for UserNotificationEvent. This utility wraps
022     * {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
027     *
028     * @author Brian Wing Shun Chan
029     * @see UserNotificationEventLocalService
030     * @see com.liferay.portal.service.base.UserNotificationEventLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl
032     * @generated
033     */
034    public class UserNotificationEventLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the user notification event to the database. Also notifies the appropriate model listeners.
043            *
044            * @param userNotificationEvent the user notification event
045            * @return the user notification event that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
049                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addUserNotificationEvent(userNotificationEvent);
052            }
053    
054            /**
055            * Creates a new user notification event with the primary key. Does not add the user notification event to the database.
056            *
057            * @param userNotificationEventId the primary key for the new user notification event
058            * @return the new user notification event
059            */
060            public static com.liferay.portal.model.UserNotificationEvent createUserNotificationEvent(
061                    long userNotificationEventId) {
062                    return getService().createUserNotificationEvent(userNotificationEventId);
063            }
064    
065            /**
066            * Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param userNotificationEventId the primary key of the user notification event
069            * @return the user notification event that was removed
070            * @throws PortalException if a user notification event with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
074                    long userNotificationEventId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteUserNotificationEvent(userNotificationEventId);
078            }
079    
080            /**
081            * Deletes the user notification event from the database. Also notifies the appropriate model listeners.
082            *
083            * @param userNotificationEvent the user notification event
084            * @return the user notification event that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
088                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteUserNotificationEvent(userNotificationEvent);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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.portal.model.impl.UserNotificationEventModelImpl}. 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.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.portal.model.impl.UserNotificationEventModelImpl}. 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEvent(
184                    long userNotificationEventId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchUserNotificationEvent(userNotificationEventId);
187            }
188    
189            /**
190            * Returns the user notification event with the matching UUID and company.
191            *
192            * @param uuid the user notification event's UUID
193            * @param companyId the primary key of the company
194            * @return the matching user notification event, or <code>null</code> if a matching user notification event could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
198                    java.lang.String uuid, long companyId)
199                    throws com.liferay.portal.kernel.exception.SystemException {
200                    return getService()
201                                       .fetchUserNotificationEventByUuidAndCompanyId(uuid, companyId);
202            }
203    
204            /**
205            * Returns the user notification event with the primary key.
206            *
207            * @param userNotificationEventId the primary key of the user notification event
208            * @return the user notification event
209            * @throws PortalException if a user notification event with the primary key could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
213                    long userNotificationEventId)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException {
216                    return getService().getUserNotificationEvent(userNotificationEventId);
217            }
218    
219            public static com.liferay.portal.model.PersistedModel getPersistedModel(
220                    java.io.Serializable primaryKeyObj)
221                    throws com.liferay.portal.kernel.exception.PortalException,
222                            com.liferay.portal.kernel.exception.SystemException {
223                    return getService().getPersistedModel(primaryKeyObj);
224            }
225    
226            /**
227            * Returns the user notification event with the matching UUID and company.
228            *
229            * @param uuid the user notification event's UUID
230            * @param companyId the primary key of the company
231            * @return the matching user notification event
232            * @throws PortalException if a matching user notification event could not be found
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
236                    java.lang.String uuid, long companyId)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException {
239                    return getService()
240                                       .getUserNotificationEventByUuidAndCompanyId(uuid, companyId);
241            }
242    
243            /**
244            * Returns a range of all the user notification events.
245            *
246            * <p>
247            * 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.portal.model.impl.UserNotificationEventModelImpl}. 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.
248            * </p>
249            *
250            * @param start the lower bound of the range of user notification events
251            * @param end the upper bound of the range of user notification events (not inclusive)
252            * @return the range of user notification events
253            * @throws SystemException if a system exception occurred
254            */
255            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
256                    int start, int end)
257                    throws com.liferay.portal.kernel.exception.SystemException {
258                    return getService().getUserNotificationEvents(start, end);
259            }
260    
261            /**
262            * Returns the number of user notification events.
263            *
264            * @return the number of user notification events
265            * @throws SystemException if a system exception occurred
266            */
267            public static int getUserNotificationEventsCount()
268                    throws com.liferay.portal.kernel.exception.SystemException {
269                    return getService().getUserNotificationEventsCount();
270            }
271    
272            /**
273            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
274            *
275            * @param userNotificationEvent the user notification event
276            * @return the user notification event that was updated
277            * @throws SystemException if a system exception occurred
278            */
279            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
280                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService().updateUserNotificationEvent(userNotificationEvent);
283            }
284    
285            /**
286            * Returns the Spring bean ID for this bean.
287            *
288            * @return the Spring bean ID for this bean
289            */
290            public static java.lang.String getBeanIdentifier() {
291                    return getService().getBeanIdentifier();
292            }
293    
294            /**
295            * Sets the Spring bean ID for this bean.
296            *
297            * @param beanIdentifier the Spring bean ID for this bean
298            */
299            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
300                    getService().setBeanIdentifier(beanIdentifier);
301            }
302    
303            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
304                    long userId,
305                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    return getService().addUserNotificationEvent(userId, notificationEvent);
309            }
310    
311            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
312                    long userId, java.lang.String type, long timestamp, long deliverBy,
313                    java.lang.String payload, boolean archived,
314                    com.liferay.portal.service.ServiceContext serviceContext)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService()
318                                       .addUserNotificationEvent(userId, type, timestamp,
319                            deliverBy, payload, archived, serviceContext);
320            }
321    
322            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
323                    long userId,
324                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().addUserNotificationEvents(userId, notificationEvents);
328            }
329    
330            public static void deleteUserNotificationEvent(java.lang.String uuid,
331                    long companyId)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteUserNotificationEvent(uuid, companyId);
334            }
335    
336            public static void deleteUserNotificationEvents(
337                    java.util.Collection<java.lang.String> uuids, long companyId)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    getService().deleteUserNotificationEvents(uuids, companyId);
340            }
341    
342            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getArchivedUserNotificationEvents(
343                    long userId, boolean archived)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getArchivedUserNotificationEvents(userId, archived);
346            }
347    
348            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getArchivedUserNotificationEvents(
349                    long userId, boolean archived, int start, int end)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService()
352                                       .getArchivedUserNotificationEvents(userId, archived, start,
353                            end);
354            }
355    
356            public static int getArchivedUserNotificationEventsCount(long userId,
357                    boolean archived)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService()
360                                       .getArchivedUserNotificationEventsCount(userId, archived);
361            }
362    
363            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
364                    long userId, boolean delivered)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getDeliveredUserNotificationEvents(userId, delivered);
367            }
368    
369            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
370                    long userId, boolean delivered, int start, int end)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService()
373                                       .getDeliveredUserNotificationEvents(userId, delivered,
374                            start, end);
375            }
376    
377            public static int getDeliveredUserNotificationEventsCount(long userId,
378                    boolean delivered)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService()
381                                       .getDeliveredUserNotificationEventsCount(userId, delivered);
382            }
383    
384            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
385                    long userId) throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getUserNotificationEvents(userId);
387            }
388    
389            /**
390            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
391            boolean)}
392            */
393            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
394                    long userId, boolean archived)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getUserNotificationEvents(userId, archived);
397            }
398    
399            /**
400            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
401            boolean, int, int)}
402            */
403            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
404                    long userId, boolean archived, int start, int end)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return getService()
407                                       .getUserNotificationEvents(userId, archived, start, end);
408            }
409    
410            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
411                    long userId, int start, int end)
412                    throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getUserNotificationEvents(userId, start, end);
414            }
415    
416            public static int getUserNotificationEventsCount(long userId)
417                    throws com.liferay.portal.kernel.exception.SystemException {
418                    return getService().getUserNotificationEventsCount(userId);
419            }
420    
421            /**
422            * @deprecated As of 6.2.0 {@link
423            #getArchivedUserNotificationEventsCount(long, boolean)}
424            */
425            public static int getUserNotificationEventsCount(long userId,
426                    boolean archived)
427                    throws com.liferay.portal.kernel.exception.SystemException {
428                    return getService().getUserNotificationEventsCount(userId, archived);
429            }
430    
431            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
432                    java.lang.String uuid, long companyId, boolean archive)
433                    throws com.liferay.portal.kernel.exception.SystemException {
434                    return getService().updateUserNotificationEvent(uuid, companyId, archive);
435            }
436    
437            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
438                    java.util.Collection<java.lang.String> uuids, long companyId,
439                    boolean archive)
440                    throws com.liferay.portal.kernel.exception.SystemException {
441                    return getService()
442                                       .updateUserNotificationEvents(uuids, companyId, archive);
443            }
444    
445            public static UserNotificationEventLocalService getService() {
446                    if (_service == null) {
447                            _service = (UserNotificationEventLocalService)PortalBeanLocatorUtil.locate(UserNotificationEventLocalService.class.getName());
448    
449                            ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
450                                    "_service");
451                    }
452    
453                    return _service;
454            }
455    
456            /**
457             * @deprecated As of 6.2.0
458             */
459            public void setService(UserNotificationEventLocalService service) {
460            }
461    
462            private static UserNotificationEventLocalService _service;
463    }