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 UserNotificationDelivery. 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 UserNotificationDeliveryLocalServiceUtil
034     * @see com.liferay.portal.service.base.UserNotificationDeliveryLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface UserNotificationDeliveryLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link UserNotificationDeliveryLocalServiceUtil} to access the user notification delivery local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048            public com.liferay.portal.model.UserNotificationDelivery addUserNotificationDelivery(
049                    long userId, java.lang.String portletId, long classNameId,
050                    int notificationType, int deliveryType, boolean deliver)
051                    throws com.liferay.portal.kernel.exception.PortalException;
052    
053            /**
054            * Adds the user notification delivery to the database. Also notifies the appropriate model listeners.
055            *
056            * @param userNotificationDelivery the user notification delivery
057            * @return the user notification delivery that was added
058            */
059            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
060            public com.liferay.portal.model.UserNotificationDelivery addUserNotificationDelivery(
061                    com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery);
062    
063            /**
064            * Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.
065            *
066            * @param userNotificationDeliveryId the primary key for the new user notification delivery
067            * @return the new user notification delivery
068            */
069            public com.liferay.portal.model.UserNotificationDelivery createUserNotificationDelivery(
070                    long userNotificationDeliveryId);
071    
072            /**
073            * @throws PortalException
074            */
075            @Override
076            public com.liferay.portal.model.PersistedModel deletePersistedModel(
077                    com.liferay.portal.model.PersistedModel persistedModel)
078                    throws com.liferay.portal.kernel.exception.PortalException;
079    
080            public void deleteUserNotificationDeliveries(long userId);
081    
082            public void deleteUserNotificationDelivery(long userId,
083                    java.lang.String portletId, long classNameId, int notificationType,
084                    int deliveryType);
085    
086            /**
087            * Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.
088            *
089            * @param userNotificationDelivery the user notification delivery
090            * @return the user notification delivery that was removed
091            */
092            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
093            public com.liferay.portal.model.UserNotificationDelivery deleteUserNotificationDelivery(
094                    com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery);
095    
096            /**
097            * Deletes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.
098            *
099            * @param userNotificationDeliveryId the primary key of the user notification delivery
100            * @return the user notification delivery that was removed
101            * @throws PortalException if a user notification delivery with the primary key could not be found
102            */
103            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
104            public com.liferay.portal.model.UserNotificationDelivery deleteUserNotificationDelivery(
105                    long userNotificationDeliveryId)
106                    throws com.liferay.portal.kernel.exception.PortalException;
107    
108            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
109    
110            /**
111            * Performs a dynamic query on the database and returns the matching rows.
112            *
113            * @param dynamicQuery the dynamic query
114            * @return the matching rows
115            */
116            public <T> java.util.List<T> dynamicQuery(
117                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
118    
119            /**
120            * Performs a dynamic query on the database and returns a range of the matching rows.
121            *
122            * <p>
123            * 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.UserNotificationDeliveryModelImpl}. 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.
124            * </p>
125            *
126            * @param dynamicQuery the dynamic query
127            * @param start the lower bound of the range of model instances
128            * @param end the upper bound of the range of model instances (not inclusive)
129            * @return the range of matching rows
130            */
131            public <T> java.util.List<T> dynamicQuery(
132                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
133                    int end);
134    
135            /**
136            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
137            *
138            * <p>
139            * 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.UserNotificationDeliveryModelImpl}. 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.
140            * </p>
141            *
142            * @param dynamicQuery the dynamic query
143            * @param start the lower bound of the range of model instances
144            * @param end the upper bound of the range of model instances (not inclusive)
145            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
146            * @return the ordered range of matching rows
147            */
148            public <T> java.util.List<T> dynamicQuery(
149                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
150                    int end,
151                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
152    
153            /**
154            * Returns the number of rows matching the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows matching the dynamic query
158            */
159            public long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
161    
162            /**
163            * Returns the number of rows matching the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @param projection the projection to apply to the query
167            * @return the number of rows matching the dynamic query
168            */
169            public long dynamicQueryCount(
170                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
171                    com.liferay.portal.kernel.dao.orm.Projection projection);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.UserNotificationDelivery fetchUserNotificationDelivery(
175                    long userId, java.lang.String portletId, long classNameId,
176                    int notificationType, int deliveryType);
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portal.model.UserNotificationDelivery fetchUserNotificationDelivery(
180                    long userNotificationDeliveryId);
181    
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
184    
185            /**
186            * Returns the Spring bean ID for this bean.
187            *
188            * @return the Spring bean ID for this bean
189            */
190            public java.lang.String getBeanIdentifier();
191    
192            @Override
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portal.model.PersistedModel getPersistedModel(
195                    java.io.Serializable primaryKeyObj)
196                    throws com.liferay.portal.kernel.exception.PortalException;
197    
198            /**
199            * Returns a range of all the user notification deliveries.
200            *
201            * <p>
202            * 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.UserNotificationDeliveryModelImpl}. 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.
203            * </p>
204            *
205            * @param start the lower bound of the range of user notification deliveries
206            * @param end the upper bound of the range of user notification deliveries (not inclusive)
207            * @return the range of user notification deliveries
208            */
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portal.model.UserNotificationDelivery> getUserNotificationDeliveries(
211                    int start, int end);
212    
213            /**
214            * Returns the number of user notification deliveries.
215            *
216            * @return the number of user notification deliveries
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getUserNotificationDeliveriesCount();
220    
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public com.liferay.portal.model.UserNotificationDelivery getUserNotificationDelivery(
223                    long userId, java.lang.String portletId, long classNameId,
224                    int notificationType, int deliveryType, boolean deliver)
225                    throws com.liferay.portal.kernel.exception.PortalException;
226    
227            /**
228            * Returns the user notification delivery with the primary key.
229            *
230            * @param userNotificationDeliveryId the primary key of the user notification delivery
231            * @return the user notification delivery
232            * @throws PortalException if a user notification delivery with the primary key could not be found
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public com.liferay.portal.model.UserNotificationDelivery getUserNotificationDelivery(
236                    long userNotificationDeliveryId)
237                    throws com.liferay.portal.kernel.exception.PortalException;
238    
239            /**
240            * Sets the Spring bean ID for this bean.
241            *
242            * @param beanIdentifier the Spring bean ID for this bean
243            */
244            public void setBeanIdentifier(java.lang.String beanIdentifier);
245    
246            /**
247            * Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
248            *
249            * @param userNotificationDelivery the user notification delivery
250            * @return the user notification delivery that was updated
251            */
252            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
253            public com.liferay.portal.model.UserNotificationDelivery updateUserNotificationDelivery(
254                    com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery);
255    
256            public com.liferay.portal.model.UserNotificationDelivery updateUserNotificationDelivery(
257                    long userNotificationDeliveryId, boolean deliver);
258    }