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