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 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.
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 MBCategoryLocalService
029     * @see com.liferay.portlet.messageboards.service.base.MBCategoryLocalServiceBaseImpl
030     * @see com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl
031     * @generated
032     */
033    public class MBCategoryLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the message boards category to the database. Also notifies the appropriate model listeners.
042            *
043            * @param mbCategory the message boards category
044            * @return the message boards category that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.messageboards.model.MBCategory addMBCategory(
048                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addMBCategory(mbCategory);
051            }
052    
053            /**
054            * Creates a new message boards category with the primary key. Does not add the message boards category to the database.
055            *
056            * @param categoryId the primary key for the new message boards category
057            * @return the new message boards category
058            */
059            public static com.liferay.portlet.messageboards.model.MBCategory createMBCategory(
060                    long categoryId) {
061                    return getService().createMBCategory(categoryId);
062            }
063    
064            /**
065            * Deletes the message boards category with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param categoryId the primary key of the message boards category
068            * @return the message boards category that was removed
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 com.liferay.portlet.messageboards.model.MBCategory deleteMBCategory(
073                    long categoryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteMBCategory(categoryId);
077            }
078    
079            /**
080            * Deletes the message boards category from the database. Also notifies the appropriate model listeners.
081            *
082            * @param mbCategory the message boards category
083            * @return the message boards category that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.messageboards.model.MBCategory deleteMBCategory(
087                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteMBCategory(mbCategory);
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.MBCategory fetchMBCategory(
168                    long categoryId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchMBCategory(categoryId);
171            }
172    
173            /**
174            * Returns the message boards category with the primary key.
175            *
176            * @param categoryId the primary key of the message boards category
177            * @return the message boards category
178            * @throws PortalException if a message boards category 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.MBCategory getMBCategory(
182                    long categoryId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getMBCategory(categoryId);
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 category with the UUID in the group.
197            *
198            * @param uuid the UUID of message boards category
199            * @param groupId the group id of the message boards category
200            * @return the message boards category
201            * @throws PortalException if a message boards category 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.MBCategory getMBCategoryByUuidAndGroupId(
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().getMBCategoryByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the message boards categories.
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 categories
219            * @param end the upper bound of the range of message boards categories (not inclusive)
220            * @return the range of message boards categories
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getMBCategories(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getMBCategories(start, end);
227            }
228    
229            /**
230            * Returns the number of message boards categories.
231            *
232            * @return the number of message boards categories
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getMBCategoriesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getMBCategoriesCount();
238            }
239    
240            /**
241            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param mbCategory the message boards category
244            * @return the message boards category that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
248                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateMBCategory(mbCategory);
251            }
252    
253            /**
254            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param mbCategory the message boards category
257            * @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.
258            * @return the message boards category that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
262                    com.liferay.portlet.messageboards.model.MBCategory mbCategory,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateMBCategory(mbCategory, 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.MBCategory addCategory(
287                    long userId, long parentCategoryId, java.lang.String name,
288                    java.lang.String description, java.lang.String displayStyle,
289                    java.lang.String emailAddress, java.lang.String inProtocol,
290                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
291                    java.lang.String inUserName, java.lang.String inPassword,
292                    int inReadInterval, java.lang.String outEmailAddress,
293                    boolean outCustom, java.lang.String outServerName, int outServerPort,
294                    boolean outUseSSL, java.lang.String outUserName,
295                    java.lang.String outPassword, boolean allowAnonymous,
296                    boolean mailingListActive,
297                    com.liferay.portal.service.ServiceContext serviceContext)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    return getService()
301                                       .addCategory(userId, parentCategoryId, name, description,
302                            displayStyle, emailAddress, inProtocol, inServerName, inServerPort,
303                            inUseSSL, inUserName, inPassword, inReadInterval, outEmailAddress,
304                            outCustom, outServerName, outServerPort, outUseSSL, outUserName,
305                            outPassword, allowAnonymous, mailingListActive, serviceContext);
306            }
307    
308            public static void addCategoryResources(long categoryId,
309                    boolean addGroupPermissions, boolean addGuestPermissions)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService()
313                            .addCategoryResources(categoryId, addGroupPermissions,
314                            addGuestPermissions);
315            }
316    
317            public static void addCategoryResources(long categoryId,
318                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService()
322                            .addCategoryResources(categoryId, groupPermissions, guestPermissions);
323            }
324    
325            public static void addCategoryResources(
326                    com.liferay.portlet.messageboards.model.MBCategory category,
327                    boolean addGroupPermissions, boolean addGuestPermissions)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService()
331                            .addCategoryResources(category, addGroupPermissions,
332                            addGuestPermissions);
333            }
334    
335            public static void addCategoryResources(
336                    com.liferay.portlet.messageboards.model.MBCategory category,
337                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService()
341                            .addCategoryResources(category, groupPermissions, guestPermissions);
342            }
343    
344            public static void deleteCategories(long groupId)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    getService().deleteCategories(groupId);
348            }
349    
350            public static void deleteCategory(long categoryId)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    getService().deleteCategory(categoryId);
354            }
355    
356            public static void deleteCategory(
357                    com.liferay.portlet.messageboards.model.MBCategory category)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    getService().deleteCategory(category);
361            }
362    
363            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
364                    long groupId)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getCategories(groupId);
367            }
368    
369            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
370                    long groupId, long parentCategoryId, int start, int end)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getCategories(groupId, parentCategoryId, start, end);
373            }
374    
375            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
376                    long groupId, long[] parentCategoryIds, int start, int end)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getCategories(groupId, parentCategoryIds, start, end);
379            }
380    
381            public static java.util.List<java.lang.Object> getCategoriesAndThreads(
382                    long groupId, long categoryId)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getCategoriesAndThreads(groupId, categoryId);
385            }
386    
387            public static int getCategoriesCount(long groupId)
388                    throws com.liferay.portal.kernel.exception.SystemException {
389                    return getService().getCategoriesCount(groupId);
390            }
391    
392            public static int getCategoriesCount(long groupId, long parentCategoryId)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getCategoriesCount(groupId, parentCategoryId);
395            }
396    
397            public static int getCategoriesCount(long groupId, long[] parentCategoryIds)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getCategoriesCount(groupId, parentCategoryIds);
400            }
401    
402            public static com.liferay.portlet.messageboards.model.MBCategory getCategory(
403                    long categoryId)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException {
406                    return getService().getCategory(categoryId);
407            }
408    
409            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
410                    long companyId, int start, int end)
411                    throws com.liferay.portal.kernel.exception.SystemException {
412                    return getService().getCompanyCategories(companyId, start, end);
413            }
414    
415            public static int getCompanyCategoriesCount(long companyId)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService().getCompanyCategoriesCount(companyId);
418            }
419    
420            public static java.util.List<java.lang.Long> getSubcategoryIds(
421                    java.util.List<java.lang.Long> categoryIds, long groupId,
422                    long categoryId)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getSubcategoryIds(categoryIds, groupId, categoryId);
425            }
426    
427            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
428                    long groupId, long userId, int start, int end)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService().getSubscribedCategories(groupId, userId, start, end);
431            }
432    
433            public static int getSubscribedCategoriesCount(long groupId, long userId)
434                    throws com.liferay.portal.kernel.exception.SystemException {
435                    return getService().getSubscribedCategoriesCount(groupId, userId);
436            }
437    
438            public static void subscribeCategory(long userId, long groupId,
439                    long categoryId)
440                    throws com.liferay.portal.kernel.exception.PortalException,
441                            com.liferay.portal.kernel.exception.SystemException {
442                    getService().subscribeCategory(userId, groupId, categoryId);
443            }
444    
445            public static void unsubscribeCategory(long userId, long groupId,
446                    long categoryId)
447                    throws com.liferay.portal.kernel.exception.PortalException,
448                            com.liferay.portal.kernel.exception.SystemException {
449                    getService().unsubscribeCategory(userId, groupId, categoryId);
450            }
451    
452            public static com.liferay.portlet.messageboards.model.MBCategory updateCategory(
453                    long categoryId, long parentCategoryId, java.lang.String name,
454                    java.lang.String description, java.lang.String displayStyle,
455                    java.lang.String emailAddress, java.lang.String inProtocol,
456                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
457                    java.lang.String inUserName, java.lang.String inPassword,
458                    int inReadInterval, java.lang.String outEmailAddress,
459                    boolean outCustom, java.lang.String outServerName, int outServerPort,
460                    boolean outUseSSL, java.lang.String outUserName,
461                    java.lang.String outPassword, boolean allowAnonymous,
462                    boolean mailingListActive, boolean mergeWithParentCategory,
463                    com.liferay.portal.service.ServiceContext serviceContext)
464                    throws com.liferay.portal.kernel.exception.PortalException,
465                            com.liferay.portal.kernel.exception.SystemException {
466                    return getService()
467                                       .updateCategory(categoryId, parentCategoryId, name,
468                            description, displayStyle, emailAddress, inProtocol, inServerName,
469                            inServerPort, inUseSSL, inUserName, inPassword, inReadInterval,
470                            outEmailAddress, outCustom, outServerName, outServerPort,
471                            outUseSSL, outUserName, outPassword, allowAnonymous,
472                            mailingListActive, mergeWithParentCategory, serviceContext);
473            }
474    
475            public static MBCategoryLocalService getService() {
476                    if (_service == null) {
477                            _service = (MBCategoryLocalService)PortalBeanLocatorUtil.locate(MBCategoryLocalService.class.getName());
478    
479                            ReferenceRegistry.registerReference(MBCategoryLocalServiceUtil.class,
480                                    "_service");
481                    }
482    
483                    return _service;
484            }
485    
486            /**
487             * @deprecated
488             */
489            public void setService(MBCategoryLocalService service) {
490            }
491    
492            private static MBCategoryLocalService _service;
493    }