001    /**
002     * Copyright (c) 2000-2012 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            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.messageboards.model.MBCategory addCategory(
272                    long userId, long parentCategoryId, java.lang.String name,
273                    java.lang.String description, java.lang.String displayStyle,
274                    java.lang.String emailAddress, java.lang.String inProtocol,
275                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
276                    java.lang.String inUserName, java.lang.String inPassword,
277                    int inReadInterval, java.lang.String outEmailAddress,
278                    boolean outCustom, java.lang.String outServerName, int outServerPort,
279                    boolean outUseSSL, java.lang.String outUserName,
280                    java.lang.String outPassword, boolean allowAnonymous,
281                    boolean mailingListActive,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addCategory(userId, parentCategoryId, name, description,
287                            displayStyle, emailAddress, inProtocol, inServerName, inServerPort,
288                            inUseSSL, inUserName, inPassword, inReadInterval, outEmailAddress,
289                            outCustom, outServerName, outServerPort, outUseSSL, outUserName,
290                            outPassword, allowAnonymous, mailingListActive, serviceContext);
291            }
292    
293            public static void addCategoryResources(long categoryId,
294                    boolean addGroupPermissions, boolean addGuestPermissions)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService()
298                            .addCategoryResources(categoryId, addGroupPermissions,
299                            addGuestPermissions);
300            }
301    
302            public static void addCategoryResources(long categoryId,
303                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService()
307                            .addCategoryResources(categoryId, groupPermissions, guestPermissions);
308            }
309    
310            public static void addCategoryResources(
311                    com.liferay.portlet.messageboards.model.MBCategory category,
312                    boolean addGroupPermissions, boolean addGuestPermissions)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService()
316                            .addCategoryResources(category, addGroupPermissions,
317                            addGuestPermissions);
318            }
319    
320            public static void addCategoryResources(
321                    com.liferay.portlet.messageboards.model.MBCategory category,
322                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    getService()
326                            .addCategoryResources(category, groupPermissions, guestPermissions);
327            }
328    
329            public static void deleteCategories(long groupId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteCategories(groupId);
333            }
334    
335            public static void deleteCategory(long categoryId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteCategory(categoryId);
339            }
340    
341            public static void deleteCategory(
342                    com.liferay.portlet.messageboards.model.MBCategory category)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService().deleteCategory(category);
346            }
347    
348            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
349                    long groupId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getCategories(groupId);
352            }
353    
354            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
355                    long groupId, long parentCategoryId, int start, int end)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getCategories(groupId, parentCategoryId, start, end);
358            }
359    
360            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
361                    long groupId, long[] parentCategoryIds, int start, int end)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getCategories(groupId, parentCategoryIds, start, end);
364            }
365    
366            public static int getCategoriesCount(long groupId)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getCategoriesCount(groupId);
369            }
370    
371            public static int getCategoriesCount(long groupId, long parentCategoryId)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getCategoriesCount(groupId, parentCategoryId);
374            }
375    
376            public static int getCategoriesCount(long groupId, long[] parentCategoryIds)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getCategoriesCount(groupId, parentCategoryIds);
379            }
380    
381            public static com.liferay.portlet.messageboards.model.MBCategory getCategory(
382                    long categoryId)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getCategory(categoryId);
386            }
387    
388            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
389                    long companyId, int start, int end)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getCompanyCategories(companyId, start, end);
392            }
393    
394            public static int getCompanyCategoriesCount(long companyId)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getCompanyCategoriesCount(companyId);
397            }
398    
399            public static java.util.List<java.lang.Long> getSubcategoryIds(
400                    java.util.List<java.lang.Long> categoryIds, long groupId,
401                    long categoryId)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getSubcategoryIds(categoryIds, groupId, categoryId);
404            }
405    
406            public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
407                    long groupId, long userId, int start, int end)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService().getSubscribedCategories(groupId, userId, start, end);
410            }
411    
412            public static int getSubscribedCategoriesCount(long groupId, long userId)
413                    throws com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getSubscribedCategoriesCount(groupId, userId);
415            }
416    
417            public static void subscribeCategory(long userId, long groupId,
418                    long categoryId)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    getService().subscribeCategory(userId, groupId, categoryId);
422            }
423    
424            public static void unsubscribeCategory(long userId, long groupId,
425                    long categoryId)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    getService().unsubscribeCategory(userId, groupId, categoryId);
429            }
430    
431            public static com.liferay.portlet.messageboards.model.MBCategory updateCategory(
432                    long categoryId, long parentCategoryId, java.lang.String name,
433                    java.lang.String description, java.lang.String displayStyle,
434                    java.lang.String emailAddress, java.lang.String inProtocol,
435                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
436                    java.lang.String inUserName, java.lang.String inPassword,
437                    int inReadInterval, java.lang.String outEmailAddress,
438                    boolean outCustom, java.lang.String outServerName, int outServerPort,
439                    boolean outUseSSL, java.lang.String outUserName,
440                    java.lang.String outPassword, boolean allowAnonymous,
441                    boolean mailingListActive, boolean mergeWithParentCategory,
442                    com.liferay.portal.service.ServiceContext serviceContext)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException {
445                    return getService()
446                                       .updateCategory(categoryId, parentCategoryId, name,
447                            description, displayStyle, emailAddress, inProtocol, inServerName,
448                            inServerPort, inUseSSL, inUserName, inPassword, inReadInterval,
449                            outEmailAddress, outCustom, outServerName, outServerPort,
450                            outUseSSL, outUserName, outPassword, allowAnonymous,
451                            mailingListActive, mergeWithParentCategory, serviceContext);
452            }
453    
454            public static MBCategoryLocalService getService() {
455                    if (_service == null) {
456                            _service = (MBCategoryLocalService)PortalBeanLocatorUtil.locate(MBCategoryLocalService.class.getName());
457    
458                            ReferenceRegistry.registerReference(MBCategoryLocalServiceUtil.class,
459                                    "_service");
460                    }
461    
462                    return _service;
463            }
464    
465            /**
466             * @deprecated
467             */
468            public void setService(MBCategoryLocalService service) {
469            }
470    
471            private static MBCategoryLocalService _service;
472    }