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