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