001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            /**
295            * @deprecated {@link #addMailingList(long, long, long, String, String,
296            String, int, boolean, String, String, int, String, boolean,
297            String, int, boolean, String, String, boolean, boolean ,
298            ServiceContext)}
299            */
300            public static com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
301                    long userId, long groupId, long categoryId,
302                    java.lang.String emailAddress, java.lang.String inProtocol,
303                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
304                    java.lang.String inUserName, java.lang.String inPassword,
305                    int inReadInterval, java.lang.String outEmailAddress,
306                    boolean outCustom, java.lang.String outServerName, int outServerPort,
307                    boolean outUseSSL, java.lang.String outUserName,
308                    java.lang.String outPassword, boolean active,
309                    com.liferay.portal.service.ServiceContext serviceContext)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    return getService()
313                                       .addMailingList(userId, groupId, categoryId, emailAddress,
314                            inProtocol, inServerName, inServerPort, inUseSSL, inUserName,
315                            inPassword, inReadInterval, outEmailAddress, outCustom,
316                            outServerName, outServerPort, outUseSSL, outUserName, outPassword,
317                            active, serviceContext);
318            }
319    
320            public static void deleteCategoryMailingList(long groupId, long categoryId)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteCategoryMailingList(groupId, categoryId);
324            }
325    
326            public static void deleteMailingList(long mailingListId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteMailingList(mailingListId);
330            }
331    
332            public static void deleteMailingList(
333                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService().deleteMailingList(mailingList);
337            }
338    
339            public static com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
340                    long groupId, long categoryId)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    return getService().getCategoryMailingList(groupId, categoryId);
344            }
345    
346            public static com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
347                    long mailingListId, java.lang.String emailAddress,
348                    java.lang.String inProtocol, java.lang.String inServerName,
349                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
350                    java.lang.String inPassword, int inReadInterval,
351                    java.lang.String outEmailAddress, boolean outCustom,
352                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
353                    java.lang.String outUserName, java.lang.String outPassword,
354                    boolean allowAnonymous, boolean active,
355                    com.liferay.portal.service.ServiceContext serviceContext)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    return getService()
359                                       .updateMailingList(mailingListId, emailAddress, inProtocol,
360                            inServerName, inServerPort, inUseSSL, inUserName, inPassword,
361                            inReadInterval, outEmailAddress, outCustom, outServerName,
362                            outServerPort, outUseSSL, outUserName, outPassword, allowAnonymous,
363                            active, serviceContext);
364            }
365    
366            /**
367            * @deprecated {@link #updateMailingList(long, String, String, String, int,
368            boolean, String, String, int, String, boolean, String, int,
369            boolean, String, String, boolean, boolean, ServiceContext)}
370            */
371            public static com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
372                    long mailingListId, java.lang.String emailAddress,
373                    java.lang.String inProtocol, java.lang.String inServerName,
374                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
375                    java.lang.String inPassword, int inReadInterval,
376                    java.lang.String outEmailAddress, boolean outCustom,
377                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
378                    java.lang.String outUserName, java.lang.String outPassword,
379                    boolean active, com.liferay.portal.service.ServiceContext serviceContext)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService()
383                                       .updateMailingList(mailingListId, emailAddress, inProtocol,
384                            inServerName, inServerPort, inUseSSL, inUserName, inPassword,
385                            inReadInterval, outEmailAddress, outCustom, outServerName,
386                            outServerPort, outUseSSL, outUserName, outPassword, active,
387                            serviceContext);
388            }
389    
390            public static MBMailingListLocalService getService() {
391                    if (_service == null) {
392                            _service = (MBMailingListLocalService)PortalBeanLocatorUtil.locate(MBMailingListLocalService.class.getName());
393    
394                            ReferenceRegistry.registerReference(MBMailingListLocalServiceUtil.class,
395                                    "_service");
396                            MethodCache.remove(MBMailingListLocalService.class);
397                    }
398    
399                    return _service;
400            }
401    
402            public void setService(MBMailingListLocalService service) {
403                    MethodCache.remove(MBMailingListLocalService.class);
404    
405                    _service = service;
406    
407                    ReferenceRegistry.registerReference(MBMailingListLocalServiceUtil.class,
408                            "_service");
409                    MethodCache.remove(MBMailingListLocalService.class);
410            }
411    
412            private static MBMailingListLocalService _service;
413    }