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