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 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 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) throws PortalException; 106 107 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 108 109 /** 110 * Performs a dynamic query on the database and returns the matching rows. 111 * 112 * @param dynamicQuery the dynamic query 113 * @return the matching rows 114 */ 115 public <T> java.util.List<T> dynamicQuery( 116 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 117 118 /** 119 * Performs a dynamic query on the database and returns a range of the matching rows. 120 * 121 * <p> 122 * 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. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @return the range of matching rows 129 */ 130 public <T> java.util.List<T> dynamicQuery( 131 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 132 int end); 133 134 /** 135 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 136 * 137 * <p> 138 * 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. 139 * </p> 140 * 141 * @param dynamicQuery the dynamic query 142 * @param start the lower bound of the range of model instances 143 * @param end the upper bound of the range of model instances (not inclusive) 144 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 145 * @return the ordered range of matching rows 146 */ 147 public <T> java.util.List<T> dynamicQuery( 148 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 149 int end, 150 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 151 152 /** 153 * Returns the number of rows matching the dynamic query. 154 * 155 * @param dynamicQuery the dynamic query 156 * @return the number of rows matching the dynamic query 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 160 161 /** 162 * Returns the number of rows matching the dynamic query. 163 * 164 * @param dynamicQuery the dynamic query 165 * @param projection the projection to apply to the query 166 * @return the number of rows matching the dynamic query 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 170 com.liferay.portal.kernel.dao.orm.Projection projection); 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public com.liferay.portal.model.UserNotificationDelivery fetchUserNotificationDelivery( 174 long userId, java.lang.String portletId, long classNameId, 175 int notificationType, int deliveryType); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portal.model.UserNotificationDelivery fetchUserNotificationDelivery( 179 long userNotificationDeliveryId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 183 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 186 187 /** 188 * Returns the OSGi service identifier. 189 * 190 * @return the OSGi service identifier 191 */ 192 public java.lang.String getOSGiServiceIdentifier(); 193 194 @Override 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.PersistedModel getPersistedModel( 197 java.io.Serializable primaryKeyObj) throws PortalException; 198 199 /** 200 * Returns a range of all the user notification deliveries. 201 * 202 * <p> 203 * 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. 204 * </p> 205 * 206 * @param start the lower bound of the range of user notification deliveries 207 * @param end the upper bound of the range of user notification deliveries (not inclusive) 208 * @return the range of user notification deliveries 209 */ 210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 211 public java.util.List<com.liferay.portal.model.UserNotificationDelivery> getUserNotificationDeliveries( 212 int start, int end); 213 214 /** 215 * Returns the number of user notification deliveries. 216 * 217 * @return the number of user notification deliveries 218 */ 219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 220 public int getUserNotificationDeliveriesCount(); 221 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public com.liferay.portal.model.UserNotificationDelivery getUserNotificationDelivery( 224 long userId, java.lang.String portletId, long classNameId, 225 int notificationType, int deliveryType, boolean deliver) 226 throws PortalException; 227 228 /** 229 * Returns the user notification delivery with the primary key. 230 * 231 * @param userNotificationDeliveryId the primary key of the user notification delivery 232 * @return the user notification delivery 233 * @throws PortalException if a user notification delivery with the primary key could not be found 234 */ 235 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 236 public com.liferay.portal.model.UserNotificationDelivery getUserNotificationDelivery( 237 long userNotificationDeliveryId) throws PortalException; 238 239 /** 240 * Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 241 * 242 * @param userNotificationDelivery the user notification delivery 243 * @return the user notification delivery that was updated 244 */ 245 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 246 public com.liferay.portal.model.UserNotificationDelivery updateUserNotificationDelivery( 247 com.liferay.portal.model.UserNotificationDelivery userNotificationDelivery); 248 249 public com.liferay.portal.model.UserNotificationDelivery updateUserNotificationDelivery( 250 long userNotificationDeliveryId, boolean deliver); 251 }