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 import com.liferay.portal.model.SystemEventConstants; 026 027 /** 028 * Provides the local service interface for EmailAddress. Methods of this 029 * service will not have security checks based on the propagated JAAS 030 * credentials because this service can only be accessed from within the same 031 * VM. 032 * 033 * @author Brian Wing Shun Chan 034 * @see EmailAddressLocalServiceUtil 035 * @see com.liferay.portal.service.base.EmailAddressLocalServiceBaseImpl 036 * @see com.liferay.portal.service.impl.EmailAddressLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface EmailAddressLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * Never modify or reference this interface directly. Always use {@link EmailAddressLocalServiceUtil} to access the email address local service. Add custom service methods to {@link com.liferay.portal.service.impl.EmailAddressLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 048 */ 049 050 /** 051 * Adds the email address to the database. Also notifies the appropriate model listeners. 052 * 053 * @param emailAddress the email address 054 * @return the email address that was added 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.EmailAddress addEmailAddress( 058 com.liferay.portal.model.EmailAddress emailAddress); 059 060 /** 061 * @deprecated As of 6.2.0, replaced by {@link #addEmailAddress(long, 062 String, long, String, int, boolean, ServiceContext)} 063 */ 064 @java.lang.Deprecated 065 public com.liferay.portal.model.EmailAddress addEmailAddress(long userId, 066 java.lang.String className, long classPK, java.lang.String address, 067 long typeId, boolean primary) throws PortalException; 068 069 public com.liferay.portal.model.EmailAddress addEmailAddress(long userId, 070 java.lang.String className, long classPK, java.lang.String address, 071 long typeId, boolean primary, 072 com.liferay.portal.service.ServiceContext serviceContext) 073 throws PortalException; 074 075 /** 076 * Creates a new email address with the primary key. Does not add the email address to the database. 077 * 078 * @param emailAddressId the primary key for the new email address 079 * @return the new email address 080 */ 081 public com.liferay.portal.model.EmailAddress createEmailAddress( 082 long emailAddressId); 083 084 /** 085 * Deletes the email address from the database. Also notifies the appropriate model listeners. 086 * 087 * @param emailAddress the email address 088 * @return the email address that was removed 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 @com.liferay.portal.kernel.systemevent.SystemEvent(action = SystemEventConstants.ACTION_SKIP, type = SystemEventConstants.TYPE_DELETE) 092 public com.liferay.portal.model.EmailAddress deleteEmailAddress( 093 com.liferay.portal.model.EmailAddress emailAddress); 094 095 /** 096 * Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param emailAddressId the primary key of the email address 099 * @return the email address that was removed 100 * @throws PortalException if a email address with the primary key could not be found 101 */ 102 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 103 public com.liferay.portal.model.EmailAddress deleteEmailAddress( 104 long emailAddressId) throws PortalException; 105 106 public void deleteEmailAddresses(long companyId, 107 java.lang.String className, long classPK); 108 109 /** 110 * @throws PortalException 111 */ 112 @Override 113 public com.liferay.portal.model.PersistedModel deletePersistedModel( 114 com.liferay.portal.model.PersistedModel persistedModel) 115 throws PortalException; 116 117 public com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 127 128 /** 129 * Performs a dynamic query on the database and returns a range of the matching rows. 130 * 131 * <p> 132 * 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.EmailAddressModelImpl}. 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @return the range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end); 143 144 /** 145 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 146 * 147 * <p> 148 * 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.EmailAddressModelImpl}. 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. 149 * </p> 150 * 151 * @param dynamicQuery the dynamic query 152 * @param start the lower bound of the range of model instances 153 * @param end the upper bound of the range of model instances (not inclusive) 154 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 155 * @return the ordered range of matching rows 156 */ 157 public <T> java.util.List<T> dynamicQuery( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 159 int end, 160 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic 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 171 /** 172 * Returns the number of rows matching the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows matching the dynamic query 177 */ 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.EmailAddress fetchEmailAddress( 184 long emailAddressId); 185 186 /** 187 * Returns the email address with the matching UUID and company. 188 * 189 * @param uuid the email address's UUID 190 * @param companyId the primary key of the company 191 * @return the matching email address, or <code>null</code> if a matching email address could not be found 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portal.model.EmailAddress fetchEmailAddressByUuidAndCompanyId( 195 java.lang.String uuid, long companyId); 196 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 199 200 /** 201 * Returns the email address with the primary key. 202 * 203 * @param emailAddressId the primary key of the email address 204 * @return the email address 205 * @throws PortalException if a email address with the primary key could not be found 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public com.liferay.portal.model.EmailAddress getEmailAddress( 209 long emailAddressId) throws PortalException; 210 211 /** 212 * Returns the email address with the matching UUID and company. 213 * 214 * @param uuid the email address's UUID 215 * @param companyId the primary key of the company 216 * @return the matching email address 217 * @throws PortalException if a matching email address could not be found 218 */ 219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 220 public com.liferay.portal.model.EmailAddress getEmailAddressByUuidAndCompanyId( 221 java.lang.String uuid, long companyId) throws PortalException; 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses(); 225 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses( 228 long companyId, java.lang.String className, long classPK); 229 230 /** 231 * Returns a range of all the email addresses. 232 * 233 * <p> 234 * 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.EmailAddressModelImpl}. 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. 235 * </p> 236 * 237 * @param start the lower bound of the range of email addresses 238 * @param end the upper bound of the range of email addresses (not inclusive) 239 * @return the range of email addresses 240 */ 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses( 243 int start, int end); 244 245 /** 246 * Returns the number of email addresses. 247 * 248 * @return the number of email addresses 249 */ 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public int getEmailAddressesCount(); 252 253 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 254 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 255 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext); 256 257 /** 258 * Returns the OSGi service identifier. 259 * 260 * @return the OSGi service identifier 261 */ 262 public java.lang.String getOSGiServiceIdentifier(); 263 264 @Override 265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 266 public com.liferay.portal.model.PersistedModel getPersistedModel( 267 java.io.Serializable primaryKeyObj) throws PortalException; 268 269 /** 270 * Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 271 * 272 * @param emailAddress the email address 273 * @return the email address that was updated 274 */ 275 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 276 public com.liferay.portal.model.EmailAddress updateEmailAddress( 277 com.liferay.portal.model.EmailAddress emailAddress); 278 279 public com.liferay.portal.model.EmailAddress updateEmailAddress( 280 long emailAddressId, java.lang.String address, long typeId, 281 boolean primary) throws PortalException; 282 }