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