001 /** 002 * Copyright (c) 2000-2013 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 EmailAddress. 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 EmailAddressLocalServiceUtil 034 * @see com.liferay.portal.service.base.EmailAddressLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.EmailAddressLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface EmailAddressLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * 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. 047 */ 048 049 /** 050 * Adds the email address to the database. Also notifies the appropriate model listeners. 051 * 052 * @param emailAddress the email address 053 * @return the email address that was added 054 * @throws SystemException if a system exception occurred 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 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new email address with the primary key. Does not add the email address to the database. 063 * 064 * @param emailAddressId the primary key for the new email address 065 * @return the new email address 066 */ 067 public com.liferay.portal.model.EmailAddress createEmailAddress( 068 long emailAddressId); 069 070 /** 071 * Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param emailAddressId the primary key of the email address 074 * @return the email address that was removed 075 * @throws PortalException if a email address with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 079 public com.liferay.portal.model.EmailAddress deleteEmailAddress( 080 long emailAddressId) 081 throws com.liferay.portal.kernel.exception.PortalException, 082 com.liferay.portal.kernel.exception.SystemException; 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 * @throws SystemException if a system exception occurred 090 */ 091 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 092 public com.liferay.portal.model.EmailAddress deleteEmailAddress( 093 com.liferay.portal.model.EmailAddress emailAddress) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 097 098 /** 099 * Performs a dynamic query on the database and returns the matching rows. 100 * 101 * @param dynamicQuery the dynamic query 102 * @return the matching rows 103 * @throws SystemException if a system exception occurred 104 */ 105 @SuppressWarnings("rawtypes") 106 public java.util.List dynamicQuery( 107 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 108 throws com.liferay.portal.kernel.exception.SystemException; 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException; 127 128 /** 129 * Performs a dynamic query on the database and returns an ordered 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 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 139 * @return the ordered range of matching rows 140 * @throws SystemException if a system exception occurred 141 */ 142 @SuppressWarnings("rawtypes") 143 public java.util.List dynamicQuery( 144 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 145 int end, 146 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 147 throws com.liferay.portal.kernel.exception.SystemException; 148 149 /** 150 * Returns the number of rows that match the dynamic query. 151 * 152 * @param dynamicQuery the dynamic query 153 * @return the number of rows that match the dynamic query 154 * @throws SystemException if a system exception occurred 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 158 throws com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Returns the number of rows that match the dynamic query. 162 * 163 * @param dynamicQuery the dynamic query 164 * @param projection the projection to apply to the query 165 * @return the number of rows that match the dynamic query 166 * @throws SystemException if a system exception occurred 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 170 com.liferay.portal.kernel.dao.orm.Projection projection) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public com.liferay.portal.model.EmailAddress fetchEmailAddress( 175 long emailAddressId) 176 throws com.liferay.portal.kernel.exception.SystemException; 177 178 /** 179 * Returns the email address with the matching UUID and company. 180 * 181 * @param uuid the email address's UUID 182 * @param companyId the primary key of the company 183 * @return the matching email address, or <code>null</code> if a matching email address could not be found 184 * @throws SystemException if a system exception occurred 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.EmailAddress fetchEmailAddressByUuidAndCompanyId( 188 java.lang.String uuid, long companyId) 189 throws com.liferay.portal.kernel.exception.SystemException; 190 191 /** 192 * Returns the email address with the primary key. 193 * 194 * @param emailAddressId the primary key of the email address 195 * @return the email address 196 * @throws PortalException if a email address with the primary key could not be found 197 * @throws SystemException if a system exception occurred 198 */ 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public com.liferay.portal.model.EmailAddress getEmailAddress( 201 long emailAddressId) 202 throws com.liferay.portal.kernel.exception.PortalException, 203 com.liferay.portal.kernel.exception.SystemException; 204 205 @Override 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public com.liferay.portal.model.PersistedModel getPersistedModel( 208 java.io.Serializable primaryKeyObj) 209 throws com.liferay.portal.kernel.exception.PortalException, 210 com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the email address with the matching UUID and company. 214 * 215 * @param uuid the email address's UUID 216 * @param companyId the primary key of the company 217 * @return the matching email address 218 * @throws PortalException if a matching email address could not be found 219 * @throws SystemException if a system exception occurred 220 */ 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public com.liferay.portal.model.EmailAddress getEmailAddressByUuidAndCompanyId( 223 java.lang.String uuid, long companyId) 224 throws com.liferay.portal.kernel.exception.PortalException, 225 com.liferay.portal.kernel.exception.SystemException; 226 227 /** 228 * Returns a range of all the email addresses. 229 * 230 * <p> 231 * 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. 232 * </p> 233 * 234 * @param start the lower bound of the range of email addresses 235 * @param end the upper bound of the range of email addresses (not inclusive) 236 * @return the range of email addresses 237 * @throws SystemException if a system exception occurred 238 */ 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses( 241 int start, int end) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 /** 245 * Returns the number of email addresses. 246 * 247 * @return the number of email addresses 248 * @throws SystemException if a system exception occurred 249 */ 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public int getEmailAddressesCount() 252 throws com.liferay.portal.kernel.exception.SystemException; 253 254 /** 255 * Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 256 * 257 * @param emailAddress the email address 258 * @return the email address that was updated 259 * @throws SystemException if a system exception occurred 260 */ 261 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 262 public com.liferay.portal.model.EmailAddress updateEmailAddress( 263 com.liferay.portal.model.EmailAddress emailAddress) 264 throws com.liferay.portal.kernel.exception.SystemException; 265 266 /** 267 * Returns the Spring bean ID for this bean. 268 * 269 * @return the Spring bean ID for this bean 270 */ 271 public java.lang.String getBeanIdentifier(); 272 273 /** 274 * Sets the Spring bean ID for this bean. 275 * 276 * @param beanIdentifier the Spring bean ID for this bean 277 */ 278 public void setBeanIdentifier(java.lang.String beanIdentifier); 279 280 /** 281 * @deprecated As of 6.2.0, replaced by {@link #addEmailAddress(long, 282 String, long, String, int, boolean, ServiceContext)} 283 */ 284 public com.liferay.portal.model.EmailAddress addEmailAddress(long userId, 285 java.lang.String className, long classPK, java.lang.String address, 286 int typeId, boolean primary) 287 throws com.liferay.portal.kernel.exception.PortalException, 288 com.liferay.portal.kernel.exception.SystemException; 289 290 public com.liferay.portal.model.EmailAddress addEmailAddress(long userId, 291 java.lang.String className, long classPK, java.lang.String address, 292 int typeId, boolean primary, 293 com.liferay.portal.service.ServiceContext serviceContext) 294 throws com.liferay.portal.kernel.exception.PortalException, 295 com.liferay.portal.kernel.exception.SystemException; 296 297 public void deleteEmailAddresses(long companyId, 298 java.lang.String className, long classPK) 299 throws com.liferay.portal.kernel.exception.SystemException; 300 301 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 302 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses() 303 throws com.liferay.portal.kernel.exception.SystemException; 304 305 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 306 public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses( 307 long companyId, java.lang.String className, long classPK) 308 throws com.liferay.portal.kernel.exception.SystemException; 309 310 public com.liferay.portal.model.EmailAddress updateEmailAddress( 311 long emailAddressId, java.lang.String address, int typeId, 312 boolean primary) 313 throws com.liferay.portal.kernel.exception.PortalException, 314 com.liferay.portal.kernel.exception.SystemException; 315 }