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 Address. 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 AddressLocalServiceUtil 034 * @see com.liferay.portal.service.base.AddressLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.AddressLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface AddressLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link AddressLocalServiceUtil} to access the address local service. Add custom service methods to {@link com.liferay.portal.service.impl.AddressLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the address to the database. Also notifies the appropriate model listeners. 051 * 052 * @param address the address 053 * @return the 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.Address addAddress( 058 com.liferay.portal.model.Address address) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new address with the primary key. Does not add the address to the database. 063 * 064 * @param addressId the primary key for the new address 065 * @return the new address 066 */ 067 public com.liferay.portal.model.Address createAddress(long addressId); 068 069 /** 070 * Deletes the address with the primary key from the database. Also notifies the appropriate model listeners. 071 * 072 * @param addressId the primary key of the address 073 * @return the address that was removed 074 * @throws PortalException if a address with the primary key could not be found 075 * @throws SystemException if a system exception occurred 076 */ 077 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 078 public com.liferay.portal.model.Address deleteAddress(long addressId) 079 throws com.liferay.portal.kernel.exception.PortalException, 080 com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Deletes the address from the database. Also notifies the appropriate model listeners. 084 * 085 * @param address the address 086 * @return the address that was removed 087 * @throws SystemException if a system exception occurred 088 */ 089 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 090 public com.liferay.portal.model.Address deleteAddress( 091 com.liferay.portal.model.Address address) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException; 107 108 /** 109 * Performs a dynamic query on the database and returns a range of the matching rows. 110 * 111 * <p> 112 * 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.AddressModelImpl}. 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. 113 * </p> 114 * 115 * @param dynamicQuery the dynamic query 116 * @param start the lower bound of the range of model instances 117 * @param end the upper bound of the range of model instances (not inclusive) 118 * @return the range of matching rows 119 * @throws SystemException if a system exception occurred 120 */ 121 @SuppressWarnings("rawtypes") 122 public java.util.List dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end) throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.AddressModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException; 146 147 /** 148 * Returns the number of rows that match the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows that match the dynamic query 152 * @throws SystemException if a system exception occurred 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 156 throws com.liferay.portal.kernel.exception.SystemException; 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @param projection the projection to apply to the query 163 * @return the number of rows that match the dynamic query 164 * @throws SystemException if a system exception occurred 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.model.Address fetchAddress(long addressId) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns the address with the matching UUID and company. 177 * 178 * @param uuid the address's UUID 179 * @param companyId the primary key of the company 180 * @return the matching address, or <code>null</code> if a matching address could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portal.model.Address fetchAddressByUuidAndCompanyId( 185 java.lang.String uuid, long companyId) 186 throws com.liferay.portal.kernel.exception.SystemException; 187 188 /** 189 * Returns the address with the primary key. 190 * 191 * @param addressId the primary key of the address 192 * @return the address 193 * @throws PortalException if a address with the primary key could not be found 194 * @throws SystemException if a system exception occurred 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.Address getAddress(long addressId) 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 address with the matching UUID and company. 210 * 211 * @param uuid the address's UUID 212 * @param companyId the primary key of the company 213 * @return the matching address 214 * @throws PortalException if a matching 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.Address getAddressByUuidAndCompanyId( 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 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.AddressModelImpl}. 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 addresses 231 * @param end the upper bound of the range of addresses (not inclusive) 232 * @return the range of 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.Address> getAddresses( 237 int start, int end) 238 throws com.liferay.portal.kernel.exception.SystemException; 239 240 /** 241 * Returns the number of addresses. 242 * 243 * @return the number of addresses 244 * @throws SystemException if a system exception occurred 245 */ 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public int getAddressesCount() 248 throws com.liferay.portal.kernel.exception.SystemException; 249 250 /** 251 * Updates the address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 252 * 253 * @param address the address 254 * @return the address that was updated 255 * @throws SystemException if a system exception occurred 256 */ 257 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 258 public com.liferay.portal.model.Address updateAddress( 259 com.liferay.portal.model.Address address) 260 throws com.liferay.portal.kernel.exception.SystemException; 261 262 /** 263 * Returns the Spring bean ID for this bean. 264 * 265 * @return the Spring bean ID for this bean 266 */ 267 public java.lang.String getBeanIdentifier(); 268 269 /** 270 * Sets the Spring bean ID for this bean. 271 * 272 * @param beanIdentifier the Spring bean ID for this bean 273 */ 274 public void setBeanIdentifier(java.lang.String beanIdentifier); 275 276 /** 277 * @deprecated As of 6.2.0, replaced by {@link #addAddress(long, String, 278 long, String, String, String, String, String, long, long, 279 int, boolean, boolean, ServiceContext)} 280 */ 281 public com.liferay.portal.model.Address addAddress(long userId, 282 java.lang.String className, long classPK, java.lang.String street1, 283 java.lang.String street2, java.lang.String street3, 284 java.lang.String city, java.lang.String zip, long regionId, 285 long countryId, int typeId, boolean mailing, boolean primary) 286 throws com.liferay.portal.kernel.exception.PortalException, 287 com.liferay.portal.kernel.exception.SystemException; 288 289 public com.liferay.portal.model.Address addAddress(long userId, 290 java.lang.String className, long classPK, java.lang.String street1, 291 java.lang.String street2, java.lang.String street3, 292 java.lang.String city, java.lang.String zip, long regionId, 293 long countryId, int typeId, boolean mailing, boolean primary, 294 com.liferay.portal.service.ServiceContext serviceContext) 295 throws com.liferay.portal.kernel.exception.PortalException, 296 com.liferay.portal.kernel.exception.SystemException; 297 298 public void deleteAddresses(long companyId, java.lang.String className, 299 long classPK) 300 throws com.liferay.portal.kernel.exception.SystemException; 301 302 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 303 public java.util.List<com.liferay.portal.model.Address> getAddresses() 304 throws com.liferay.portal.kernel.exception.SystemException; 305 306 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 307 public java.util.List<com.liferay.portal.model.Address> getAddresses( 308 long companyId, java.lang.String className, long classPK) 309 throws com.liferay.portal.kernel.exception.SystemException; 310 311 public com.liferay.portal.model.Address updateAddress(long addressId, 312 java.lang.String street1, java.lang.String street2, 313 java.lang.String street3, java.lang.String city, java.lang.String zip, 314 long regionId, long countryId, int typeId, boolean mailing, 315 boolean primary) 316 throws com.liferay.portal.kernel.exception.PortalException, 317 com.liferay.portal.kernel.exception.SystemException; 318 }