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     * Provides the local service utility for MBMailingList. This utility wraps
022     * {@link com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl} 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 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            * @return the message boards mailing list that was removed
070            * @throws PortalException if a message boards mailing list with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList(
074                    long mailingListId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteMBMailingList(mailingListId);
078            }
079    
080            /**
081            * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners.
082            *
083            * @param mbMailingList the message boards mailing list
084            * @return the message boards mailing list that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList(
088                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteMBMailingList(mbMailingList);
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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.portlet.messageboards.model.MBMailingList fetchMBMailingList(
184                    long mailingListId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchMBMailingList(mailingListId);
187            }
188    
189            /**
190            * Returns the message boards mailing list with the matching UUID and company.
191            *
192            * @param uuid the message boards mailing list's UUID
193            * @param companyId the primary key of the company
194            * @return the matching message boards mailing list, or <code>null</code> if a matching message boards mailing list could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingListByUuidAndCompanyId(
198                    java.lang.String uuid, long companyId)
199                    throws com.liferay.portal.kernel.exception.SystemException {
200                    return getService().fetchMBMailingListByUuidAndCompanyId(uuid, companyId);
201            }
202    
203            /**
204            * Returns the message boards mailing list matching the UUID and group.
205            *
206            * @param uuid the message boards mailing list's UUID
207            * @param groupId the primary key of the group
208            * @return the matching message boards mailing list, or <code>null</code> if a matching message boards mailing list could not be found
209            * @throws SystemException if a system exception occurred
210            */
211            public static com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingListByUuidAndGroupId(
212                    java.lang.String uuid, long groupId)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().fetchMBMailingListByUuidAndGroupId(uuid, groupId);
215            }
216    
217            /**
218            * Returns the message boards mailing list with the primary key.
219            *
220            * @param mailingListId the primary key of the message boards mailing list
221            * @return the message boards mailing list
222            * @throws PortalException if a message boards mailing list with the primary key could not be found
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList(
226                    long mailingListId)
227                    throws com.liferay.portal.kernel.exception.PortalException,
228                            com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getMBMailingList(mailingListId);
230            }
231    
232            public static com.liferay.portal.model.PersistedModel getPersistedModel(
233                    java.io.Serializable primaryKeyObj)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getPersistedModel(primaryKeyObj);
237            }
238    
239            /**
240            * Returns the message boards mailing list with the matching UUID and company.
241            *
242            * @param uuid the message boards mailing list's UUID
243            * @param companyId the primary key of the company
244            * @return the matching message boards mailing list
245            * @throws PortalException if a matching message boards mailing list could not be found
246            * @throws SystemException if a system exception occurred
247            */
248            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndCompanyId(
249                    java.lang.String uuid, long companyId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException {
252                    return getService().getMBMailingListByUuidAndCompanyId(uuid, companyId);
253            }
254    
255            /**
256            * Returns the message boards mailing list matching the UUID and group.
257            *
258            * @param uuid the message boards mailing list's UUID
259            * @param groupId the primary key of the group
260            * @return the matching message boards mailing list
261            * @throws PortalException if a matching message boards mailing list could not be found
262            * @throws SystemException if a system exception occurred
263            */
264            public static com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId(
265                    java.lang.String uuid, long groupId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService().getMBMailingListByUuidAndGroupId(uuid, groupId);
269            }
270    
271            /**
272            * Returns a range of all the message boards mailing lists.
273            *
274            * <p>
275            * 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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.
276            * </p>
277            *
278            * @param start the lower bound of the range of message boards mailing lists
279            * @param end the upper bound of the range of message boards mailing lists (not inclusive)
280            * @return the range of message boards mailing lists
281            * @throws SystemException if a system exception occurred
282            */
283            public static java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists(
284                    int start, int end)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    return getService().getMBMailingLists(start, end);
287            }
288    
289            /**
290            * Returns the number of message boards mailing lists.
291            *
292            * @return the number of message boards mailing lists
293            * @throws SystemException if a system exception occurred
294            */
295            public static int getMBMailingListsCount()
296                    throws com.liferay.portal.kernel.exception.SystemException {
297                    return getService().getMBMailingListsCount();
298            }
299    
300            /**
301            * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
302            *
303            * @param mbMailingList the message boards mailing list
304            * @return the message boards mailing list that was updated
305            * @throws SystemException if a system exception occurred
306            */
307            public static com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
308                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
309                    throws com.liferay.portal.kernel.exception.SystemException {
310                    return getService().updateMBMailingList(mbMailingList);
311            }
312    
313            /**
314            * Returns the Spring bean ID for this bean.
315            *
316            * @return the Spring bean ID for this bean
317            */
318            public static java.lang.String getBeanIdentifier() {
319                    return getService().getBeanIdentifier();
320            }
321    
322            /**
323            * Sets the Spring bean ID for this bean.
324            *
325            * @param beanIdentifier the Spring bean ID for this bean
326            */
327            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
328                    getService().setBeanIdentifier(beanIdentifier);
329            }
330    
331            public static com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
332                    long userId, long groupId, long categoryId,
333                    java.lang.String emailAddress, java.lang.String inProtocol,
334                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
335                    java.lang.String inUserName, java.lang.String inPassword,
336                    int inReadInterval, java.lang.String outEmailAddress,
337                    boolean outCustom, java.lang.String outServerName, int outServerPort,
338                    boolean outUseSSL, java.lang.String outUserName,
339                    java.lang.String outPassword, boolean allowAnonymous, boolean active,
340                    com.liferay.portal.service.ServiceContext serviceContext)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    return getService()
344                                       .addMailingList(userId, groupId, categoryId, emailAddress,
345                            inProtocol, inServerName, inServerPort, inUseSSL, inUserName,
346                            inPassword, inReadInterval, outEmailAddress, outCustom,
347                            outServerName, outServerPort, outUseSSL, outUserName, outPassword,
348                            allowAnonymous, active, serviceContext);
349            }
350    
351            public static void deleteCategoryMailingList(long groupId, long categoryId)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    getService().deleteCategoryMailingList(groupId, categoryId);
355            }
356    
357            public static void deleteMailingList(long mailingListId)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    getService().deleteMailingList(mailingListId);
361            }
362    
363            public static void deleteMailingList(
364                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException {
367                    getService().deleteMailingList(mailingList);
368            }
369    
370            public static com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
371                    long groupId, long categoryId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getCategoryMailingList(groupId, categoryId);
375            }
376    
377            public static com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
378                    long mailingListId, java.lang.String emailAddress,
379                    java.lang.String inProtocol, java.lang.String inServerName,
380                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
381                    java.lang.String inPassword, int inReadInterval,
382                    java.lang.String outEmailAddress, boolean outCustom,
383                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
384                    java.lang.String outUserName, java.lang.String outPassword,
385                    boolean allowAnonymous, boolean active,
386                    com.liferay.portal.service.ServiceContext serviceContext)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    return getService()
390                                       .updateMailingList(mailingListId, emailAddress, inProtocol,
391                            inServerName, inServerPort, inUseSSL, inUserName, inPassword,
392                            inReadInterval, outEmailAddress, outCustom, outServerName,
393                            outServerPort, outUseSSL, outUserName, outPassword, allowAnonymous,
394                            active, serviceContext);
395            }
396    
397            public static MBMailingListLocalService getService() {
398                    if (_service == null) {
399                            _service = (MBMailingListLocalService)PortalBeanLocatorUtil.locate(MBMailingListLocalService.class.getName());
400    
401                            ReferenceRegistry.registerReference(MBMailingListLocalServiceUtil.class,
402                                    "_service");
403                    }
404    
405                    return _service;
406            }
407    
408            /**
409             * @deprecated As of 6.2.0
410             */
411            public void setService(MBMailingListLocalService service) {
412            }
413    
414            private static MBMailingListLocalService _service;
415    }