001    /**
002     * Copyright (c) 2000-2011 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            /**
162            * Returns the message boards mailing list with the primary key.
163            *
164            * @param mailingListId the primary key of the message boards mailing list
165            * @return the message boards mailing list
166            * @throws PortalException if a message boards mailing list with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList(
170                    long mailingListId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getMBMailingList(mailingListId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the message boards mailing list with the UUID in the group.
185            *
186            * @param uuid the UUID of message boards mailing list
187            * @param groupId the group id of the message boards mailing list
188            * @return the message boards mailing list
189            * @throws PortalException if a message boards mailing list with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getMBMailingListByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the message boards mailing lists.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of message boards mailing lists
207            * @param end the upper bound of the range of message boards mailing lists (not inclusive)
208            * @return the range of message boards mailing lists
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getMBMailingLists(start, end);
215            }
216    
217            /**
218            * Returns the number of message boards mailing lists.
219            *
220            * @return the number of message boards mailing lists
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getMBMailingListsCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getMBMailingListsCount();
226            }
227    
228            /**
229            * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param mbMailingList the message boards mailing list
232            * @return the message boards mailing list that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
236                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateMBMailingList(mbMailingList);
239            }
240    
241            /**
242            * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param mbMailingList the message boards mailing list
245            * @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.
246            * @return the message boards mailing list that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
250                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateMBMailingList(mbMailingList, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
275                    long userId, long groupId, long categoryId,
276                    java.lang.String emailAddress, java.lang.String inProtocol,
277                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
278                    java.lang.String inUserName, java.lang.String inPassword,
279                    int inReadInterval, java.lang.String outEmailAddress,
280                    boolean outCustom, java.lang.String outServerName, int outServerPort,
281                    boolean outUseSSL, java.lang.String outUserName,
282                    java.lang.String outPassword, boolean allowAnonymous, boolean active,
283                    com.liferay.portal.service.ServiceContext serviceContext)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService()
287                                       .addMailingList(userId, groupId, categoryId, emailAddress,
288                            inProtocol, inServerName, inServerPort, inUseSSL, inUserName,
289                            inPassword, inReadInterval, outEmailAddress, outCustom,
290                            outServerName, outServerPort, outUseSSL, outUserName, outPassword,
291                            allowAnonymous, active, serviceContext);
292            }
293    
294            public static void deleteCategoryMailingList(long groupId, long categoryId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteCategoryMailingList(groupId, categoryId);
298            }
299    
300            public static void deleteMailingList(long mailingListId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteMailingList(mailingListId);
304            }
305    
306            public static void deleteMailingList(
307                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().deleteMailingList(mailingList);
311            }
312    
313            public static com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
314                    long groupId, long categoryId)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getCategoryMailingList(groupId, categoryId);
318            }
319    
320            public static com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
321                    long mailingListId, java.lang.String emailAddress,
322                    java.lang.String inProtocol, java.lang.String inServerName,
323                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
324                    java.lang.String inPassword, int inReadInterval,
325                    java.lang.String outEmailAddress, boolean outCustom,
326                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
327                    java.lang.String outUserName, java.lang.String outPassword,
328                    boolean allowAnonymous, boolean active,
329                    com.liferay.portal.service.ServiceContext serviceContext)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    return getService()
333                                       .updateMailingList(mailingListId, emailAddress, inProtocol,
334                            inServerName, inServerPort, inUseSSL, inUserName, inPassword,
335                            inReadInterval, outEmailAddress, outCustom, outServerName,
336                            outServerPort, outUseSSL, outUserName, outPassword, allowAnonymous,
337                            active, serviceContext);
338            }
339    
340            public static MBMailingListLocalService getService() {
341                    if (_service == null) {
342                            _service = (MBMailingListLocalService)PortalBeanLocatorUtil.locate(MBMailingListLocalService.class.getName());
343    
344                            ReferenceRegistry.registerReference(MBMailingListLocalServiceUtil.class,
345                                    "_service");
346                            MethodCache.remove(MBMailingListLocalService.class);
347                    }
348    
349                    return _service;
350            }
351    
352            public void setService(MBMailingListLocalService service) {
353                    MethodCache.remove(MBMailingListLocalService.class);
354    
355                    _service = service;
356    
357                    ReferenceRegistry.registerReference(MBMailingListLocalServiceUtil.class,
358                            "_service");
359                    MethodCache.remove(MBMailingListLocalService.class);
360            }
361    
362            private static MBMailingListLocalService _service;
363    }