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