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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * Provides the local service interface for UserNotificationEvent. Methods of this
025     * service will not have security checks based on the propagated JAAS
026     * credentials because this service can only be accessed from within the same
027     * VM.
028     *
029     * @author Brian Wing Shun Chan
030     * @see UserNotificationEventLocalServiceUtil
031     * @see com.liferay.portal.service.base.UserNotificationEventLocalServiceBaseImpl
032     * @see com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl
033     * @generated
034     */
035    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
036            PortalException.class, SystemException.class})
037    public interface UserNotificationEventLocalService extends BaseLocalService,
038            PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. Always use {@link UserNotificationEventLocalServiceUtil} to access the user notification event local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
043             */
044    
045            /**
046            * Adds the user notification event to the database. Also notifies the appropriate model listeners.
047            *
048            * @param userNotificationEvent the user notification event
049            * @return the user notification event that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
053                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new user notification event with the primary key. Does not add the user notification event to the database.
058            *
059            * @param userNotificationEventId the primary key for the new user notification event
060            * @return the new user notification event
061            */
062            public com.liferay.portal.model.UserNotificationEvent createUserNotificationEvent(
063                    long userNotificationEventId);
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 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    
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            * @return the user notification event that was removed
083            * @throws SystemException if a system exception occurred
084            */
085            public com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
086                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
087                    throws com.liferay.portal.kernel.exception.SystemException;
088    
089            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
090    
091            /**
092            * Performs a dynamic query on the database and returns the matching rows.
093            *
094            * @param dynamicQuery the dynamic query
095            * @return the matching rows
096            * @throws SystemException if a system exception occurred
097            */
098            @SuppressWarnings("rawtypes")
099            public java.util.List dynamicQuery(
100                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
101                    throws com.liferay.portal.kernel.exception.SystemException;
102    
103            /**
104            * Performs a dynamic query on the database and returns a range of the matching rows.
105            *
106            * <p>
107            * 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.
108            * </p>
109            *
110            * @param dynamicQuery the dynamic query
111            * @param start the lower bound of the range of model instances
112            * @param end the upper bound of the range of model instances (not inclusive)
113            * @return the range of matching rows
114            * @throws SystemException if a system exception occurred
115            */
116            @SuppressWarnings("rawtypes")
117            public java.util.List dynamicQuery(
118                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
119                    int end) throws com.liferay.portal.kernel.exception.SystemException;
120    
121            /**
122            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
123            *
124            * <p>
125            * 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.
126            * </p>
127            *
128            * @param dynamicQuery the dynamic query
129            * @param start the lower bound of the range of model instances
130            * @param end the upper bound of the range of model instances (not inclusive)
131            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
132            * @return the ordered range of matching rows
133            * @throws SystemException if a system exception occurred
134            */
135            @SuppressWarnings("rawtypes")
136            public java.util.List dynamicQuery(
137                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
138                    int end,
139                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
140                    throws com.liferay.portal.kernel.exception.SystemException;
141    
142            /**
143            * Returns the number of rows that match the dynamic query.
144            *
145            * @param dynamicQuery the dynamic query
146            * @return the number of rows that match the dynamic query
147            * @throws SystemException if a system exception occurred
148            */
149            public long dynamicQueryCount(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
151                    throws com.liferay.portal.kernel.exception.SystemException;
152    
153            /**
154            * Returns the number of rows that match the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @param projection the projection to apply to the query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
163                    com.liferay.portal.kernel.dao.orm.Projection projection)
164                    throws com.liferay.portal.kernel.exception.SystemException;
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEvent(
168                    long userNotificationEventId)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            /**
172            * Returns the user notification event with the matching UUID and company.
173            *
174            * @param uuid the user notification event's UUID
175            * @param companyId the primary key of the company
176            * @return the matching user notification event, or <code>null</code> if a matching user notification event could not be found
177            * @throws SystemException if a system exception occurred
178            */
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
181                    java.lang.String uuid, long companyId)
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns the user notification event with the primary key.
186            *
187            * @param userNotificationEventId the primary key of the user notification event
188            * @return the user notification event
189            * @throws PortalException if a user notification event with the primary key could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
194                    long userNotificationEventId)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException;
197    
198            @Override
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public com.liferay.portal.model.PersistedModel getPersistedModel(
201                    java.io.Serializable primaryKeyObj)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            /**
206            * Returns the user notification event with the matching UUID and company.
207            *
208            * @param uuid the user notification event's UUID
209            * @param companyId the primary key of the company
210            * @return the matching user notification event
211            * @throws PortalException if a matching user notification event could not be found
212            * @throws SystemException if a system exception occurred
213            */
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public com.liferay.portal.model.UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
216                    java.lang.String uuid, long companyId)
217                    throws com.liferay.portal.kernel.exception.PortalException,
218                            com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns a range of all the user notification events.
222            *
223            * <p>
224            * 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.
225            * </p>
226            *
227            * @param start the lower bound of the range of user notification events
228            * @param end the upper bound of the range of user notification events (not inclusive)
229            * @return the range of user notification events
230            * @throws SystemException if a system exception occurred
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
234                    int start, int end)
235                    throws com.liferay.portal.kernel.exception.SystemException;
236    
237            /**
238            * Returns the number of user notification events.
239            *
240            * @return the number of user notification events
241            * @throws SystemException if a system exception occurred
242            */
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public int getUserNotificationEventsCount()
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param userNotificationEvent the user notification event
251            * @return the user notification event that was updated
252            * @throws SystemException if a system exception occurred
253            */
254            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
255                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
256                    throws com.liferay.portal.kernel.exception.SystemException;
257    
258            /**
259            * Returns the Spring bean ID for this bean.
260            *
261            * @return the Spring bean ID for this bean
262            */
263            public java.lang.String getBeanIdentifier();
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public void setBeanIdentifier(java.lang.String beanIdentifier);
271    
272            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
273                    long userId,
274                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
279                    long userId, java.lang.String type, long timestamp, long deliverBy,
280                    java.lang.String payload, boolean archived,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            public java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
286                    long userId,
287                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void deleteUserNotificationEvent(java.lang.String uuid,
292                    long companyId)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            public void deleteUserNotificationEvents(
296                    java.util.Collection<java.lang.String> uuids, long companyId)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getArchivedUserNotificationEvents(
301                    long userId, boolean archived)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getArchivedUserNotificationEvents(
306                    long userId, boolean archived, int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public int getArchivedUserNotificationEventsCount(long userId,
311                    boolean archived)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
316                    long userId, boolean delivered)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
321                    long userId, boolean delivered, int start, int end)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public int getDeliveredUserNotificationEventsCount(long userId,
326                    boolean delivered)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
331                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
332    
333            /**
334            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
335            boolean)}
336            */
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
339                    long userId, boolean archived)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            /**
343            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
344            boolean, int, int)}
345            */
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
348                    long userId, boolean archived, int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
353                    long userId, int start, int end)
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public int getUserNotificationEventsCount(long userId)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            /**
361            * @deprecated As of 6.2.0 {@link
362            #getArchivedUserNotificationEventsCount(long, boolean)}
363            */
364            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
365            public int getUserNotificationEventsCount(long userId, boolean archived)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
369                    java.lang.String uuid, long companyId, boolean archive)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            public java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
373                    java.util.Collection<java.lang.String> uuids, long companyId,
374                    boolean archive)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    }