001    /**
002     * Copyright (c) 2000-2012 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     * The interface for the user notification event local service.
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see UserNotificationEventLocalServiceUtil
032     * @see com.liferay.portal.service.base.UserNotificationEventLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface UserNotificationEventLocalService
039            extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * 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.
044             */
045    
046            /**
047            * Adds the user notification event to the database. Also notifies the appropriate model listeners.
048            *
049            * @param userNotificationEvent the user notification event
050            * @return the user notification event that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
054                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new user notification event with the primary key. Does not add the user notification event to the database.
059            *
060            * @param userNotificationEventId the primary key for the new user notification event
061            * @return the new user notification event
062            */
063            public com.liferay.portal.model.UserNotificationEvent createUserNotificationEvent(
064                    long userNotificationEventId);
065    
066            /**
067            * Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param userNotificationEventId the primary key of the user notification event
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 void deleteUserNotificationEvent(long userNotificationEventId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the user notification event from the database. Also notifies the appropriate model listeners.
079            *
080            * @param userNotificationEvent the user notification event
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteUserNotificationEvent(
084                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portal.model.UserNotificationEvent fetchUserNotificationEvent(
151                    long userNotificationEventId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the user notification event with the primary key.
156            *
157            * @param userNotificationEventId the primary key of the user notification event
158            * @return the user notification event
159            * @throws PortalException if a user notification event with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portal.model.UserNotificationEvent getUserNotificationEvent(
164                    long userNotificationEventId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns a range of all the user notification events.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param start the lower bound of the range of user notification events
182            * @param end the upper bound of the range of user notification events (not inclusive)
183            * @return the range of user notification events
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
188                    int start, int end)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the number of user notification events.
193            *
194            * @return the number of user notification events
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public int getUserNotificationEventsCount()
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
203            *
204            * @param userNotificationEvent the user notification event
205            * @return the user notification event that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
209                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param userNotificationEvent the user notification event
216            * @param merge whether to merge the user notification event with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
217            * @return the user notification event that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
221                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent,
222                    boolean merge)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
240                    long userId,
241                    com.liferay.portal.kernel.notifications.NotificationEvent notificationEvent)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException;
244    
245            public com.liferay.portal.model.UserNotificationEvent addUserNotificationEvent(
246                    long userId, java.lang.String type, long timestamp, long deliverBy,
247                    java.lang.String payload, boolean archived,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            public java.util.List<com.liferay.portal.model.UserNotificationEvent> addUserNotificationEvents(
253                    long userId,
254                    java.util.Collection<com.liferay.portal.kernel.notifications.NotificationEvent> notificationEvents)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            public void deleteUserNotificationEvent(java.lang.String uuid)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deleteUserNotificationEvents(
262                    java.util.Collection<java.lang.String> uuids)
263                    throws com.liferay.portal.kernel.exception.SystemException;
264    
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
267                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
271                    long userId, boolean archived)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
276                    long userId, boolean archived, int start, int end)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
280            public java.util.List<com.liferay.portal.model.UserNotificationEvent> getUserNotificationEvents(
281                    long userId, int start, int end)
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public int getUserNotificationEventsCount(long userId)
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public int getUserNotificationEventsCount(long userId, boolean archived)
290                    throws com.liferay.portal.kernel.exception.SystemException;
291    
292            public com.liferay.portal.model.UserNotificationEvent updateUserNotificationEvent(
293                    java.lang.String uuid, boolean archive)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            public java.util.List<com.liferay.portal.model.UserNotificationEvent> updateUserNotificationEvents(
297                    java.util.Collection<java.lang.String> uuids, boolean archive)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    }