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.portal.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 user notification event local service. This utility wraps {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} 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 UserNotificationEventLocalService
029     * @see com.liferay.portal.service.base.UserNotificationEventLocalServiceBaseImpl
030     * @see com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl
031     * @generated
032     */
033    public class UserNotificationEventLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the user notification event to the database. Also notifies the appropriate model listeners.
042            *
043            * @param userNotificationEvent the user notification event
044            * @return the user notification event that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
048                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addUserNotificationEvent(userNotificationEvent);
051            }
052    
053            /**
054            * Creates a new user notification event with the primary key. Does not add the user notification event to the database.
055            *
056            * @param userNotificationEventId the primary key for the new user notification event
057            * @return the new user notification event
058            */
059            public static com.liferay.portal.model.UserNotificationEvent createUserNotificationEvent(
060                    long userNotificationEventId) {
061                    return getService().createUserNotificationEvent(userNotificationEventId);
062            }
063    
064            /**
065            * Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param userNotificationEventId the primary key of the user notification event
068            * @return the user notification event that was removed
069            * @throws PortalException if a user notification event with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
073                    long userNotificationEventId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteUserNotificationEvent(userNotificationEventId);
077            }
078    
079            /**
080            * Deletes the user notification event from the database. Also notifies the appropriate model listeners.
081            *
082            * @param userNotificationEvent the user notification event
083            * @return the user notification event that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
087                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteUserNotificationEvent(userNotificationEvent);
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.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.
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.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.
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.portal.model.UserNotificationEvent fetchUserNotificationEvent(
168                    long userNotificationEventId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchUserNotificationEvent(userNotificationEventId);
171            }
172    
173            /**
174            * Returns the user notification event with the primary key.
175            *
176            * @param userNotificationEventId the primary key of the user notification event
177            * @return the user notification event
178            * @throws PortalException if a user notification event with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
182                    long userNotificationEventId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getUserNotificationEvent(userNotificationEventId);
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 user notification events.
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.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.
200            * </p>
201            *
202            * @param start the lower bound of the range of user notification events
203            * @param end the upper bound of the range of user notification events (not inclusive)
204            * @return the range of user notification events
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getUserNotificationEvents(start, end);
211            }
212    
213            /**
214            * Returns the number of user notification events.
215            *
216            * @return the number of user notification events
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getUserNotificationEventsCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getUserNotificationEventsCount();
222            }
223    
224            /**
225            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param userNotificationEvent the user notification event
228            * @return the user notification event that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
232                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateUserNotificationEvent(userNotificationEvent);
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.portal.model.UserNotificationEvent addUserNotificationEvent(
256                    long userId,
257                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException {
260                    return getService().addUserNotificationEvent(userId, notificationEvent);
261            }
262    
263            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
264                    long userId, java.lang.String type, long timestamp, long deliverBy,
265                    java.lang.String payload, boolean archived,
266                    com.liferay.portal.service.ServiceContext serviceContext)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    return getService()
270                                       .addUserNotificationEvent(userId, type, timestamp,
271                            deliverBy, payload, archived, serviceContext);
272            }
273    
274            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
275                    long userId,
276                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService().addUserNotificationEvents(userId, notificationEvents);
280            }
281    
282            public static void deleteUserNotificationEvent(java.lang.String uuid,
283                    long companyId)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    getService().deleteUserNotificationEvent(uuid, companyId);
286            }
287    
288            public static void deleteUserNotificationEvents(
289                    java.util.Collection<java.lang.String> uuids, long companyId)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteUserNotificationEvents(uuids, companyId);
292            }
293    
294            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
295                    long userId) throws com.liferay.portal.kernel.exception.SystemException {
296                    return getService().getUserNotificationEvents(userId);
297            }
298    
299            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
300                    long userId, boolean archived)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getUserNotificationEvents(userId, archived);
303            }
304    
305            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
306                    long userId, boolean archived, int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    return getService()
309                                       .getUserNotificationEvents(userId, archived, start, end);
310            }
311    
312            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
313                    long userId, int start, int end)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService().getUserNotificationEvents(userId, start, end);
316            }
317    
318            public static int getUserNotificationEventsCount(long userId)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getUserNotificationEventsCount(userId);
321            }
322    
323            public static int getUserNotificationEventsCount(long userId,
324                    boolean archived)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getUserNotificationEventsCount(userId, archived);
327            }
328    
329            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
330                    java.lang.String uuid, long companyId, boolean archive)
331                    throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().updateUserNotificationEvent(uuid, companyId, archive);
333            }
334    
335            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
336                    java.util.Collection<java.lang.String> uuids, long companyId,
337                    boolean archive)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService()
340                                       .updateUserNotificationEvents(uuids, companyId, archive);
341            }
342    
343            public static UserNotificationEventLocalService getService() {
344                    if (_service == null) {
345                            _service = (UserNotificationEventLocalService)PortalBeanLocatorUtil.locate(UserNotificationEventLocalService.class.getName());
346    
347                            ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
348                                    "_service");
349                    }
350    
351                    return _service;
352            }
353    
354            /**
355             * @deprecated
356             */
357            public void setService(UserNotificationEventLocalService service) {
358            }
359    
360            private static UserNotificationEventLocalService _service;
361    }