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