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