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