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 Address. 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 AddressLocalServiceUtil 035 * @see com.liferay.portal.service.base.AddressLocalServiceBaseImpl 036 * @see com.liferay.portal.service.impl.AddressLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface AddressLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * 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. 048 */ 049 050 /** 051 * Adds the address to the database. Also notifies the appropriate model listeners. 052 * 053 * @param address the address 054 * @return the address that was added 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 060 /** 061 * @deprecated As of 6.2.0, replaced by {@link #addAddress(long, String, 062 long, String, String, String, String, String, long, long, 063 int, boolean, boolean, ServiceContext)} 064 */ 065 @java.lang.Deprecated 066 public com.liferay.portal.model.Address addAddress(long userId, 067 java.lang.String className, long classPK, java.lang.String street1, 068 java.lang.String street2, java.lang.String street3, 069 java.lang.String city, java.lang.String zip, long regionId, 070 long countryId, long typeId, boolean mailing, boolean primary) 071 throws PortalException; 072 073 public com.liferay.portal.model.Address addAddress(long userId, 074 java.lang.String className, long classPK, java.lang.String street1, 075 java.lang.String street2, java.lang.String street3, 076 java.lang.String city, java.lang.String zip, long regionId, 077 long countryId, long typeId, boolean mailing, boolean primary, 078 com.liferay.portal.service.ServiceContext serviceContext) 079 throws PortalException; 080 081 /** 082 * Creates a new address with the primary key. Does not add the address to the database. 083 * 084 * @param addressId the primary key for the new address 085 * @return the new address 086 */ 087 public com.liferay.portal.model.Address createAddress(long addressId); 088 089 /** 090 * Deletes the address from the database. Also notifies the appropriate model listeners. 091 * 092 * @param address the address 093 * @return the address that was removed 094 */ 095 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 096 @com.liferay.portal.kernel.systemevent.SystemEvent(action = SystemEventConstants.ACTION_SKIP, type = SystemEventConstants.TYPE_DELETE) 097 public com.liferay.portal.model.Address deleteAddress( 098 com.liferay.portal.model.Address address); 099 100 /** 101 * Deletes the address with the primary key from the database. Also notifies the appropriate model listeners. 102 * 103 * @param addressId the primary key of the address 104 * @return the address that was removed 105 * @throws PortalException if a address with the primary key could not be found 106 */ 107 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 108 public com.liferay.portal.model.Address deleteAddress(long addressId) 109 throws PortalException; 110 111 public void deleteAddresses(long companyId, java.lang.String className, 112 long classPK); 113 114 /** 115 * @throws PortalException 116 */ 117 @Override 118 public com.liferay.portal.model.PersistedModel deletePersistedModel( 119 com.liferay.portal.model.PersistedModel persistedModel) 120 throws PortalException; 121 122 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 123 124 /** 125 * Performs a dynamic query on the database and returns the matching rows. 126 * 127 * @param dynamicQuery the dynamic query 128 * @return the matching rows 129 */ 130 public <T> java.util.List<T> dynamicQuery( 131 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 132 133 /** 134 * Performs a dynamic query on the database and returns a range of the matching rows. 135 * 136 * <p> 137 * 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. 138 * </p> 139 * 140 * @param dynamicQuery the dynamic query 141 * @param start the lower bound of the range of model instances 142 * @param end the upper bound of the range of model instances (not inclusive) 143 * @return the range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end); 148 149 /** 150 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 151 * 152 * <p> 153 * 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. 154 * </p> 155 * 156 * @param dynamicQuery the dynamic query 157 * @param start the lower bound of the range of model instances 158 * @param end the upper bound of the range of model instances (not inclusive) 159 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 160 * @return the ordered range of matching rows 161 */ 162 public <T> java.util.List<T> dynamicQuery( 163 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 164 int end, 165 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 166 167 /** 168 * Returns the number of rows matching the dynamic query. 169 * 170 * @param dynamicQuery the dynamic query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount( 174 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 175 176 /** 177 * Returns the number of rows matching the dynamic query. 178 * 179 * @param dynamicQuery the dynamic query 180 * @param projection the projection to apply to the query 181 * @return the number of rows matching the dynamic query 182 */ 183 public long dynamicQueryCount( 184 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 185 com.liferay.portal.kernel.dao.orm.Projection projection); 186 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public com.liferay.portal.model.Address fetchAddress(long addressId); 189 190 /** 191 * Returns the address with the matching UUID and company. 192 * 193 * @param uuid the address's UUID 194 * @param companyId the primary key of the company 195 * @return the matching address, or <code>null</code> if a matching address could not be found 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.model.Address fetchAddressByUuidAndCompanyId( 199 java.lang.String uuid, long companyId); 200 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 203 204 /** 205 * Returns the address with the primary key. 206 * 207 * @param addressId the primary key of the address 208 * @return the address 209 * @throws PortalException if a address with the primary key could not be found 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public com.liferay.portal.model.Address getAddress(long addressId) 213 throws PortalException; 214 215 /** 216 * Returns the address with the matching UUID and company. 217 * 218 * @param uuid the address's UUID 219 * @param companyId the primary key of the company 220 * @return the matching address 221 * @throws PortalException if a matching address could not be found 222 */ 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public com.liferay.portal.model.Address getAddressByUuidAndCompanyId( 225 java.lang.String uuid, long companyId) throws PortalException; 226 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public java.util.List<com.liferay.portal.model.Address> getAddresses(); 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public java.util.List<com.liferay.portal.model.Address> getAddresses( 232 long companyId, java.lang.String className, long classPK); 233 234 /** 235 * Returns a range of all the addresses. 236 * 237 * <p> 238 * 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. 239 * </p> 240 * 241 * @param start the lower bound of the range of addresses 242 * @param end the upper bound of the range of addresses (not inclusive) 243 * @return the range of addresses 244 */ 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public java.util.List<com.liferay.portal.model.Address> getAddresses( 247 int start, int end); 248 249 /** 250 * Returns the number of addresses. 251 * 252 * @return the number of addresses 253 */ 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public int getAddressesCount(); 256 257 /** 258 * Returns the Spring bean ID for this bean. 259 * 260 * @return the Spring bean ID for this bean 261 */ 262 public java.lang.String getBeanIdentifier(); 263 264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 265 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 266 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext); 267 268 @Override 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public com.liferay.portal.model.PersistedModel getPersistedModel( 271 java.io.Serializable primaryKeyObj) throws PortalException; 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 * Updates the address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 282 * 283 * @param address the address 284 * @return the address that was updated 285 */ 286 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 287 public com.liferay.portal.model.Address updateAddress( 288 com.liferay.portal.model.Address address); 289 290 public com.liferay.portal.model.Address updateAddress(long addressId, 291 java.lang.String street1, java.lang.String street2, 292 java.lang.String street3, java.lang.String city, java.lang.String zip, 293 long regionId, long countryId, long typeId, boolean mailing, 294 boolean primary) throws PortalException; 295 }