001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.messageboards.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the message boards category local service. This utility wraps {@link com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl} 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 MBCategoryLocalService
030     * @see com.liferay.portlet.messageboards.service.base.MBCategoryLocalServiceBaseImpl
031     * @see com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl
032     * @generated
033     */
034    public class MBCategoryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the message boards category to the database. Also notifies the appropriate model listeners.
043            *
044            * @param mbCategory the message boards category
045            * @return the message boards category that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.messageboards.model.MBCategory addMBCategory(
049                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addMBCategory(mbCategory);
052            }
053    
054            /**
055            * Creates a new message boards category with the primary key. Does not add the message boards category to the database.
056            *
057            * @param categoryId the primary key for the new message boards category
058            * @return the new message boards category
059            */
060            public static com.liferay.portlet.messageboards.model.MBCategory createMBCategory(
061                    long categoryId) {
062                    return getService().createMBCategory(categoryId);
063            }
064    
065            /**
066            * Deletes the message boards category with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param categoryId the primary key of the message boards category
069            * @throws PortalException if a message boards category with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteMBCategory(long categoryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteMBCategory(categoryId);
076            }
077    
078            /**
079            * Deletes the message boards category from the database. Also notifies the appropriate model listeners.
080            *
081            * @param mbCategory the message boards category
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteMBCategory(
085                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteMBCategory(mbCategory);
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 category with the primary key.
163            *
164            * @param categoryId the primary key of the message boards category
165            * @return the message boards category
166            * @throws PortalException if a message boards category 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.MBCategory getMBCategory(
170                    long categoryId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getMBCategory(categoryId);
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 category with the UUID in the group.
185            *
186            * @param uuid the UUID of message boards category
187            * @param groupId the group id of the message boards category
188            * @return the message boards category
189            * @throws PortalException if a message boards category 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.MBCategory getMBCategoryByUuidAndGroupId(
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().getMBCategoryByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the message boards categories.
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 categories
207            * @param end the upper bound of the range of message boards categories (not inclusive)
208            * @return the range of message boards categories
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getMBCategories(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getMBCategories(start, end);
215            }
216    
217            /**
218            * Returns the number of message boards categories.
219            *
220            * @return the number of message boards categories
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getMBCategoriesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getMBCategoriesCount();
226            }
227    
228            /**
229            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param mbCategory the message boards category
232            * @return the message boards category that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
236                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateMBCategory(mbCategory);
239            }
240    
241            /**
242            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param mbCategory the message boards category
245            * @param merge whether to merge the message boards category 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 category that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
250                    com.liferay.portlet.messageboards.model.MBCategory mbCategory,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateMBCategory(mbCategory, 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.MBCategory addCategory(
275                    long userId, long parentCategoryId, java.lang.String name,
276                    java.lang.String description, java.lang.String displayStyle,
277                    java.lang.String emailAddress, java.lang.String inProtocol,
278                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
279                    java.lang.String inUserName, java.lang.String inPassword,
280                    int inReadInterval, java.lang.String outEmailAddress,
281                    boolean outCustom, java.lang.String outServerName, int outServerPort,
282                    boolean outUseSSL, java.lang.String outUserName,
283                    java.lang.String outPassword, boolean allowAnonymous,
284                    boolean mailingListActive,
285                    com.liferay.portal.service.ServiceContext serviceContext)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService()
289                                       .addCategory(userId, parentCategoryId, name, description,
290                            displayStyle, emailAddress, inProtocol, inServerName, inServerPort,
291                            inUseSSL, inUserName, inPassword, inReadInterval, outEmailAddress,
292                            outCustom, outServerName, outServerPort, outUseSSL, outUserName,
293                            outPassword, allowAnonymous, mailingListActive, serviceContext);
294            }
295    
296            public static void addCategoryResources(long categoryId,
297                    boolean addGroupPermissions, boolean addGuestPermissions)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService()
301                            .addCategoryResources(categoryId, addGroupPermissions,
302                            addGuestPermissions);
303            }
304    
305            public static void addCategoryResources(long categoryId,
306                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService()
310                            .addCategoryResources(categoryId, groupPermissions, guestPermissions);
311            }
312    
313            public static void addCategoryResources(
314                    com.liferay.portlet.messageboards.model.MBCategory category,
315                    boolean addGroupPermissions, boolean addGuestPermissions)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService()
319                            .addCategoryResources(category, addGroupPermissions,
320                            addGuestPermissions);
321            }
322    
323            public static void addCategoryResources(
324                    com.liferay.portlet.messageboards.model.MBCategory category,
325                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    getService()
329                            .addCategoryResources(category, groupPermissions, guestPermissions);
330            }
331    
332            public static void deleteCategories(long groupId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService().deleteCategories(groupId);
336            }
337    
338            public static void deleteCategory(long categoryId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    getService().deleteCategory(categoryId);
342            }
343    
344            public static void deleteCategory(
345                    com.liferay.portlet.messageboards.model.MBCategory category)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService().deleteCategory(category);
349            }
350    
351            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
352                    long groupId)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getCategories(groupId);
355            }
356    
357            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
358                    long groupId, long parentCategoryId, int start, int end)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getCategories(groupId, parentCategoryId, start, end);
361            }
362    
363            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
364                    long groupId, long[] parentCategoryIds, int start, int end)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getCategories(groupId, parentCategoryIds, start, end);
367            }
368    
369            public static int getCategoriesCount(long groupId)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getCategoriesCount(groupId);
372            }
373    
374            public static int getCategoriesCount(long groupId, long parentCategoryId)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getCategoriesCount(groupId, parentCategoryId);
377            }
378    
379            public static int getCategoriesCount(long groupId, long[] parentCategoryIds)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getCategoriesCount(groupId, parentCategoryIds);
382            }
383    
384            public static com.liferay.portlet.messageboards.model.MBCategory getCategory(
385                    long categoryId)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getCategory(categoryId);
389            }
390    
391            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
392                    long companyId, int start, int end)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getCompanyCategories(companyId, start, end);
395            }
396    
397            public static int getCompanyCategoriesCount(long companyId)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getCompanyCategoriesCount(companyId);
400            }
401    
402            public static java.util.List<java.lang.Long> getSubcategoryIds(
403                    java.util.List<java.lang.Long> categoryIds, long groupId,
404                    long categoryId)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return getService().getSubcategoryIds(categoryIds, groupId, categoryId);
407            }
408    
409            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
410                    long groupId, long userId, int start, int end)
411                    throws com.liferay.portal.kernel.exception.SystemException {
412                    return getService().getSubscribedCategories(groupId, userId, start, end);
413            }
414    
415            public static int getSubscribedCategoriesCount(long groupId, long userId)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService().getSubscribedCategoriesCount(groupId, userId);
418            }
419    
420            public static void subscribeCategory(long userId, long groupId,
421                    long categoryId)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException {
424                    getService().subscribeCategory(userId, groupId, categoryId);
425            }
426    
427            public static void unsubscribeCategory(long userId, long groupId,
428                    long categoryId)
429                    throws com.liferay.portal.kernel.exception.PortalException,
430                            com.liferay.portal.kernel.exception.SystemException {
431                    getService().unsubscribeCategory(userId, groupId, categoryId);
432            }
433    
434            public static com.liferay.portlet.messageboards.model.MBCategory updateCategory(
435                    long categoryId, long parentCategoryId, java.lang.String name,
436                    java.lang.String description, java.lang.String displayStyle,
437                    java.lang.String emailAddress, java.lang.String inProtocol,
438                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
439                    java.lang.String inUserName, java.lang.String inPassword,
440                    int inReadInterval, java.lang.String outEmailAddress,
441                    boolean outCustom, java.lang.String outServerName, int outServerPort,
442                    boolean outUseSSL, java.lang.String outUserName,
443                    java.lang.String outPassword, boolean allowAnonymous,
444                    boolean mailingListActive, boolean mergeWithParentCategory,
445                    com.liferay.portal.service.ServiceContext serviceContext)
446                    throws com.liferay.portal.kernel.exception.PortalException,
447                            com.liferay.portal.kernel.exception.SystemException {
448                    return getService()
449                                       .updateCategory(categoryId, parentCategoryId, name,
450                            description, displayStyle, emailAddress, inProtocol, inServerName,
451                            inServerPort, inUseSSL, inUserName, inPassword, inReadInterval,
452                            outEmailAddress, outCustom, outServerName, outServerPort,
453                            outUseSSL, outUserName, outPassword, allowAnonymous,
454                            mailingListActive, mergeWithParentCategory, serviceContext);
455            }
456    
457            public static MBCategoryLocalService getService() {
458                    if (_service == null) {
459                            _service = (MBCategoryLocalService)PortalBeanLocatorUtil.locate(MBCategoryLocalService.class.getName());
460    
461                            ReferenceRegistry.registerReference(MBCategoryLocalServiceUtil.class,
462                                    "_service");
463                            MethodCache.remove(MBCategoryLocalService.class);
464                    }
465    
466                    return _service;
467            }
468    
469            public void setService(MBCategoryLocalService service) {
470                    MethodCache.remove(MBCategoryLocalService.class);
471    
472                    _service = service;
473    
474                    ReferenceRegistry.registerReference(MBCategoryLocalServiceUtil.class,
475                            "_service");
476                    MethodCache.remove(MBCategoryLocalService.class);
477            }
478    
479            private static MBCategoryLocalService _service;
480    }