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.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    
049            /**
050            * Adds the user notification event to the database. Also notifies the appropriate model listeners.
051            *
052            * @param userNotificationEvent the user notification event
053            * @return the user notification event that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
058                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new user notification event with the primary key. Does not add the user notification event to the database.
063            *
064            * @param userNotificationEventId the primary key for the new user notification event
065            * @return the new user notification event
066            */
067            public com.liferay.portal.model.UserNotificationEvent createUserNotificationEvent(
068                    long userNotificationEventId);
069    
070            /**
071            * Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param userNotificationEventId the primary key of the user notification event
074            * @return the user notification event that was removed
075            * @throws PortalException if a user notification event with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
079            public com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
080                    long userNotificationEventId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Deletes the user notification event from the database. Also notifies the appropriate model listeners.
086            *
087            * @param userNotificationEvent the user notification event
088            * @return the user notification event that was removed
089            * @throws SystemException if a system exception occurred
090            */
091            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
092            public com.liferay.portal.model.UserNotificationEvent deleteUserNotificationEvent(
093                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
097    
098            /**
099            * Performs a dynamic query on the database and returns the matching rows.
100            *
101            * @param dynamicQuery the dynamic query
102            * @return the matching rows
103            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserNotificationEventModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException;
127    
128            /**
129            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
130            *
131            * <p>
132            * 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.
133            * </p>
134            *
135            * @param dynamicQuery the dynamic query
136            * @param start the lower bound of the range of model instances
137            * @param end the upper bound of the range of model instances (not inclusive)
138            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching rows
140            * @throws SystemException if a system exception occurred
141            */
142            @SuppressWarnings("rawtypes")
143            public java.util.List dynamicQuery(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
145                    int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the number of rows that match the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows that match the dynamic query
154            * @throws SystemException if a system exception occurred
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
158                    throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the number of rows that match the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @param projection the projection to apply to the query
165            * @return the number of rows that match the dynamic query
166            * @throws SystemException if a system exception occurred
167            */
168            public long dynamicQueryCount(
169                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
170                    com.liferay.portal.kernel.dao.orm.Projection projection)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEvent(
175                    long userNotificationEventId)
176                    throws com.liferay.portal.kernel.exception.SystemException;
177    
178            /**
179            * Returns the user notification event with the matching UUID and company.
180            *
181            * @param uuid the user notification event's UUID
182            * @param companyId the primary key of the company
183            * @return the matching user notification event, or <code>null</code> if a matching user notification event could not be found
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(
188                    java.lang.String uuid, long companyId)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the user notification event with the primary key.
193            *
194            * @param userNotificationEventId the primary key of the user notification event
195            * @return the user notification event
196            * @throws PortalException if a user notification event with the primary key could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
201                    long userNotificationEventId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            @Override
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Returns the user notification event with the matching UUID and company.
214            *
215            * @param uuid the user notification event's UUID
216            * @param companyId the primary key of the company
217            * @return the matching user notification event
218            * @throws PortalException if a matching user notification event could not be found
219            * @throws SystemException if a system exception occurred
220            */
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public com.liferay.portal.model.UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(
223                    java.lang.String uuid, long companyId)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Returns a range of all the user notification events.
229            *
230            * <p>
231            * 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.
232            * </p>
233            *
234            * @param start the lower bound of the range of user notification events
235            * @param end the upper bound of the range of user notification events (not inclusive)
236            * @return the range of user notification events
237            * @throws SystemException if a system exception occurred
238            */
239            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
241                    int start, int end)
242                    throws com.liferay.portal.kernel.exception.SystemException;
243    
244            /**
245            * Returns the number of user notification events.
246            *
247            * @return the number of user notification events
248            * @throws SystemException if a system exception occurred
249            */
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public int getUserNotificationEventsCount()
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            /**
255            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
256            *
257            * @param userNotificationEvent the user notification event
258            * @return the user notification event that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
262            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
263                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            /**
267            * Returns the Spring bean ID for this bean.
268            *
269            * @return the Spring bean ID for this bean
270            */
271            public java.lang.String getBeanIdentifier();
272    
273            /**
274            * Sets the Spring bean ID for this bean.
275            *
276            * @param beanIdentifier the Spring bean ID for this bean
277            */
278            public void setBeanIdentifier(java.lang.String beanIdentifier);
279    
280            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
281                    long userId,
282                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
287                    long userId, java.lang.String type, long timestamp, long deliverBy,
288                    java.lang.String payload, boolean archived,
289                    com.liferay.portal.service.ServiceContext serviceContext)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException;
292    
293            public java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
294                    long userId,
295                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteUserNotificationEvent(java.lang.String uuid,
300                    long companyId)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            public void deleteUserNotificationEvents(
304                    java.util.Collection<java.lang.String> uuids, long companyId)
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)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getArchivedUserNotificationEvents(
314                    long userId, boolean archived, int start, int end)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public int getArchivedUserNotificationEventsCount(long userId,
319                    boolean archived)
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)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getDeliveredUserNotificationEvents(
329                    long userId, boolean delivered, int start, int end)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public int getDeliveredUserNotificationEventsCount(long userId,
334                    boolean delivered)
335                    throws com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
339                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
340    
341            /**
342            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
343            boolean)}
344            */
345            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
347                    long userId, boolean archived)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            /**
351            * @deprecated As of 6.2.0 {@link #getArchivedUserNotificationEvents(long,
352            boolean, int, int)}
353            */
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
356                    long userId, boolean archived, int start, int end)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
361                    long userId, int start, int end)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
365            public int getUserNotificationEventsCount(long userId)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            /**
369            * @deprecated As of 6.2.0 {@link
370            #getArchivedUserNotificationEventsCount(long, boolean)}
371            */
372            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
373            public int getUserNotificationEventsCount(long userId, boolean archived)
374                    throws com.liferay.portal.kernel.exception.SystemException;
375    
376            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
377                    java.lang.String uuid, long companyId, boolean archive)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            public java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
381                    java.util.Collection<java.lang.String> uuids, long companyId,
382                    boolean archive)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    }