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