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