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