001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see MBMailingListLocalService
032     * @see com.liferay.portlet.messageboards.service.base.MBMailingListLocalServiceBaseImpl
033     * @see com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl
034     * @generated
035     */
036    public class MBMailingListLocalServiceUtil {
037            /**
038            * Adds the message boards mailing list to the database. Also notifies the appropriate model listeners.
039            *
040            * @param mbMailingList the message boards mailing list to add
041            * @return the message boards mailing list that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.messageboards.model.MBMailingList addMBMailingList(
045                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addMBMailingList(mbMailingList);
048            }
049    
050            /**
051            * Creates a new message boards mailing list with the primary key. Does not add the message boards mailing list to the database.
052            *
053            * @param mailingListId the primary key for the new message boards mailing list
054            * @return the new message boards mailing list
055            */
056            public static com.liferay.portlet.messageboards.model.MBMailingList createMBMailingList(
057                    long mailingListId) {
058                    return getService().createMBMailingList(mailingListId);
059            }
060    
061            /**
062            * Deletes the message boards mailing list with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param mailingListId the primary key of the message boards mailing list to delete
065            * @throws PortalException if a message boards mailing list with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteMBMailingList(long mailingListId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteMBMailingList(mailingListId);
072            }
073    
074            /**
075            * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners.
076            *
077            * @param mbMailingList the message boards mailing list to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteMBMailingList(
081                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteMBMailingList(mbMailingList);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the message boards mailing list with the primary key.
159            *
160            * @param mailingListId the primary key of the message boards mailing list to get
161            * @return the message boards mailing list
162            * @throws PortalException if a message boards mailing list with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList(
166                    long mailingListId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getMBMailingList(mailingListId);
170            }
171    
172            /**
173            * Gets the message boards mailing list with the UUID and group id.
174            *
175            * @param uuid the UUID of message boards mailing list to get
176            * @param groupId the group id of the message boards mailing list to get
177            * @return the message boards mailing list
178            * @throws PortalException if a message boards mailing list with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getMBMailingListByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the message boards mailing lists.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of message boards mailing lists to return
196            * @param end the upper bound of the range of message boards mailing lists to return (not inclusive)
197            * @return the range of message boards mailing lists
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getMBMailingLists(start, end);
204            }
205    
206            /**
207            * Gets the number of message boards mailing lists.
208            *
209            * @return the number of message boards mailing lists
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getMBMailingListsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getMBMailingListsCount();
215            }
216    
217            /**
218            * Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.
219            *
220            * @param mbMailingList the message boards mailing list to update
221            * @return the message boards mailing list that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
225                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateMBMailingList(mbMailingList);
228            }
229    
230            /**
231            * Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.
232            *
233            * @param mbMailingList the message boards mailing list to update
234            * @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.
235            * @return the message boards mailing list that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
239                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateMBMailingList(mbMailingList, merge);
243            }
244    
245            public static com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
246                    long userId, long groupId, long categoryId,
247                    java.lang.String emailAddress, java.lang.String inProtocol,
248                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
249                    java.lang.String inUserName, java.lang.String inPassword,
250                    int inReadInterval, java.lang.String outEmailAddress,
251                    boolean outCustom, java.lang.String outServerName, int outServerPort,
252                    boolean outUseSSL, java.lang.String outUserName,
253                    java.lang.String outPassword, boolean active,
254                    com.liferay.portal.service.ServiceContext serviceContext)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException {
257                    return getService()
258                                       .addMailingList(userId, groupId, categoryId, emailAddress,
259                            inProtocol, inServerName, inServerPort, inUseSSL, inUserName,
260                            inPassword, inReadInterval, outEmailAddress, outCustom,
261                            outServerName, outServerPort, outUseSSL, outUserName, outPassword,
262                            active, serviceContext);
263            }
264    
265            public static void deleteCategoryMailingList(long groupId, long categoryId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    getService().deleteCategoryMailingList(groupId, categoryId);
269            }
270    
271            public static void deleteMailingList(long mailingListId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    getService().deleteMailingList(mailingListId);
275            }
276    
277            public static void deleteMailingList(
278                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService().deleteMailingList(mailingList);
282            }
283    
284            public static com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
285                    long groupId, long categoryId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getCategoryMailingList(groupId, categoryId);
289            }
290    
291            public static com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
292                    long mailingListId, java.lang.String emailAddress,
293                    java.lang.String inProtocol, java.lang.String inServerName,
294                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
295                    java.lang.String inPassword, int inReadInterval,
296                    java.lang.String outEmailAddress, boolean outCustom,
297                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
298                    java.lang.String outUserName, java.lang.String outPassword,
299                    boolean active, com.liferay.portal.service.ServiceContext serviceContext)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return getService()
303                                       .updateMailingList(mailingListId, emailAddress, inProtocol,
304                            inServerName, inServerPort, inUseSSL, inUserName, inPassword,
305                            inReadInterval, outEmailAddress, outCustom, outServerName,
306                            outServerPort, outUseSSL, outUserName, outPassword, active,
307                            serviceContext);
308            }
309    
310            public static MBMailingListLocalService getService() {
311                    if (_service == null) {
312                            _service = (MBMailingListLocalService)PortalBeanLocatorUtil.locate(MBMailingListLocalService.class.getName());
313                    }
314    
315                    return _service;
316            }
317    
318            public void setService(MBMailingListLocalService service) {
319                    _service = service;
320            }
321    
322            private static MBMailingListLocalService _service;
323    }