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