001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see 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            * @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 void deleteUserNotificationEvent(long userNotificationEventId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteUserNotificationEvent(userNotificationEventId);
076            }
077    
078            /**
079            * Deletes the user notification event from the database. Also notifies the appropriate model listeners.
080            *
081            * @param userNotificationEvent the user notification event
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteUserNotificationEvent(
085                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteUserNotificationEvent(userNotificationEvent);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the user notification event with the primary key.
163            *
164            * @param userNotificationEventId the primary key of the user notification event
165            * @return the user notification event
166            * @throws PortalException if a user notification event with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
170                    long userNotificationEventId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getUserNotificationEvent(userNotificationEventId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the user notification events.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of user notification events
191            * @param end the upper bound of the range of user notification events (not inclusive)
192            * @return the range of user notification events
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getUserNotificationEvents(start, end);
199            }
200    
201            /**
202            * Returns the number of user notification events.
203            *
204            * @return the number of user notification events
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getUserNotificationEventsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getUserNotificationEventsCount();
210            }
211    
212            /**
213            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param userNotificationEvent the user notification event
216            * @return the user notification event that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
220                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateUserNotificationEvent(userNotificationEvent);
223            }
224    
225            /**
226            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param userNotificationEvent the user notification event
229            * @param merge whether to merge the user notification event 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.
230            * @return the user notification event that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
234                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService()
238                                       .updateUserNotificationEvent(userNotificationEvent, merge);
239            }
240    
241            /**
242            * Returns the Spring bean ID for this bean.
243            *
244            * @return the Spring bean ID for this bean
245            */
246            public static java.lang.String getBeanIdentifier() {
247                    return getService().getBeanIdentifier();
248            }
249    
250            /**
251            * Sets the Spring bean ID for this bean.
252            *
253            * @param beanIdentifier the Spring bean ID for this bean
254            */
255            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
256                    getService().setBeanIdentifier(beanIdentifier);
257            }
258    
259            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
260                    long userId,
261                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService().addUserNotificationEvent(userId, notificationEvent);
265            }
266    
267            public static com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
268                    long userId, java.lang.String type, long timestamp, long deliverBy,
269                    java.lang.String payload, boolean archived,
270                    com.liferay.portal.service.ServiceContext serviceContext)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    return getService()
274                                       .addUserNotificationEvent(userId, type, timestamp,
275                            deliverBy, payload, archived, serviceContext);
276            }
277    
278            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
279                    long userId,
280                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    return getService().addUserNotificationEvents(userId, notificationEvents);
284            }
285    
286            public static void deleteUserNotificationEvent(java.lang.String uuid)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteUserNotificationEvent(uuid);
289            }
290    
291            public static void deleteUserNotificationEvents(
292                    java.util.Collection<java.lang.String> uuids)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    getService().deleteUserNotificationEvents(uuids);
295            }
296    
297            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
298                    long userId) throws com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getUserNotificationEvents(userId);
300            }
301    
302            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
303                    long userId, boolean archived)
304                    throws com.liferay.portal.kernel.exception.SystemException {
305                    return getService().getUserNotificationEvents(userId, archived);
306            }
307    
308            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
309                    long userId, boolean archived, int start, int end)
310                    throws com.liferay.portal.kernel.exception.SystemException {
311                    return getService()
312                                       .getUserNotificationEvents(userId, archived, start, end);
313            }
314    
315            public static com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
316                    java.lang.String uuid, boolean archive)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService().updateUserNotificationEvent(uuid, archive);
319            }
320    
321            public static java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
322                    java.util.Collection<java.lang.String> uuids, boolean archive)
323                    throws com.liferay.portal.kernel.exception.SystemException {
324                    return getService().updateUserNotificationEvents(uuids, archive);
325            }
326    
327            public static UserNotificationEventLocalService getService() {
328                    if (_service == null) {
329                            _service = (UserNotificationEventLocalService)PortalBeanLocatorUtil.locate(UserNotificationEventLocalService.class.getName());
330    
331                            ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
332                                    "_service");
333                            MethodCache.remove(UserNotificationEventLocalService.class);
334                    }
335    
336                    return _service;
337            }
338    
339            public void setService(UserNotificationEventLocalService service) {
340                    MethodCache.remove(UserNotificationEventLocalService.class);
341    
342                    _service = service;
343    
344                    ReferenceRegistry.registerReference(UserNotificationEventLocalServiceUtil.class,
345                            "_service");
346                    MethodCache.remove(UserNotificationEventLocalService.class);
347            }
348    
349            private static UserNotificationEventLocalService _service;
350    }