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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the message boards category local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see MBCategoryLocalServiceUtil
033     * @see com.liferay.portlet.messageboards.service.base.MBCategoryLocalServiceBaseImpl
034     * @see com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface MBCategoryLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link MBCategoryLocalServiceUtil} to access the message boards category local service. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the message boards category to the database. Also notifies the appropriate model listeners.
048            *
049            * @param mbCategory the message boards category
050            * @return the message boards category that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.messageboards.model.MBCategory addMBCategory(
054                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new message boards category with the primary key. Does not add the message boards category to the database.
059            *
060            * @param categoryId the primary key for the new message boards category
061            * @return the new message boards category
062            */
063            public com.liferay.portlet.messageboards.model.MBCategory createMBCategory(
064                    long categoryId);
065    
066            /**
067            * Deletes the message boards category with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param categoryId the primary key of the message boards category
070            * @throws PortalException if a message boards category with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteMBCategory(long categoryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the message boards category from the database. Also notifies the appropriate model listeners.
079            *
080            * @param mbCategory the message boards category
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteMBCategory(
084                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.messageboards.model.MBCategory fetchMBCategory(
151                    long categoryId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the message boards category with the primary key.
156            *
157            * @param categoryId the primary key of the message boards category
158            * @return the message boards category
159            * @throws PortalException if a message boards category with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.messageboards.model.MBCategory getMBCategory(
164                    long categoryId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the message boards category with the UUID in the group.
176            *
177            * @param uuid the UUID of message boards category
178            * @param groupId the group id of the message boards category
179            * @return the message boards category
180            * @throws PortalException if a message boards category with the UUID in the group could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.messageboards.model.MBCategory getMBCategoryByUuidAndGroupId(
185                    java.lang.String uuid, long groupId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns a range of all the message boards categories.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of message boards categories
197            * @param end the upper bound of the range of message boards categories (not inclusive)
198            * @return the range of message boards categories
199            * @throws SystemException if a system exception occurred
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getMBCategories(
203                    int start, int end)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Returns the number of message boards categories.
208            *
209            * @return the number of message boards categories
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public int getMBCategoriesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
218            *
219            * @param mbCategory the message boards category
220            * @return the message boards category that was updated
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
224                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param mbCategory the message boards category
231            * @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.
232            * @return the message boards category that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
236                    com.liferay.portlet.messageboards.model.MBCategory mbCategory,
237                    boolean merge)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portlet.messageboards.model.MBCategory addCategory(
255                    long userId, long parentCategoryId, java.lang.String name,
256                    java.lang.String description, java.lang.String displayStyle,
257                    java.lang.String emailAddress, java.lang.String inProtocol,
258                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
259                    java.lang.String inUserName, java.lang.String inPassword,
260                    int inReadInterval, java.lang.String outEmailAddress,
261                    boolean outCustom, java.lang.String outServerName, int outServerPort,
262                    boolean outUseSSL, java.lang.String outUserName,
263                    java.lang.String outPassword, boolean allowAnonymous,
264                    boolean mailingListActive,
265                    com.liferay.portal.service.ServiceContext serviceContext)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void addCategoryResources(long categoryId,
270                    boolean addGroupPermissions, boolean addGuestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void addCategoryResources(long categoryId,
275                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public void addCategoryResources(
280                    com.liferay.portlet.messageboards.model.MBCategory category,
281                    boolean addGroupPermissions, boolean addGuestPermissions)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            public void addCategoryResources(
286                    com.liferay.portlet.messageboards.model.MBCategory category,
287                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void deleteCategories(long groupId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public void deleteCategory(long categoryId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteCategory(
300                    com.liferay.portlet.messageboards.model.MBCategory category)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
306                    long groupId)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
311                    long groupId, long parentCategoryId, int start, int end)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
316                    long groupId, long[] parentCategoryIds, int start, int end)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public int getCategoriesCount(long groupId)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public int getCategoriesCount(long groupId, long parentCategoryId)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public int getCategoriesCount(long groupId, long[] parentCategoryIds)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public com.liferay.portlet.messageboards.model.MBCategory getCategory(
333                    long categoryId)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
339                    long companyId, int start, int end)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public int getCompanyCategoriesCount(long companyId)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<java.lang.Long> getSubcategoryIds(
348                    java.util.List<java.lang.Long> categoryIds, long groupId,
349                    long categoryId)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
354                    long groupId, long userId, int start, int end)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getSubscribedCategoriesCount(long groupId, long userId)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            public void subscribeCategory(long userId, long groupId, long categoryId)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException;
364    
365            public void unsubscribeCategory(long userId, long groupId, long categoryId)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException;
368    
369            public com.liferay.portlet.messageboards.model.MBCategory updateCategory(
370                    long categoryId, long parentCategoryId, java.lang.String name,
371                    java.lang.String description, java.lang.String displayStyle,
372                    java.lang.String emailAddress, java.lang.String inProtocol,
373                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
374                    java.lang.String inUserName, java.lang.String inPassword,
375                    int inReadInterval, java.lang.String outEmailAddress,
376                    boolean outCustom, java.lang.String outServerName, int outServerPort,
377                    boolean outUseSSL, java.lang.String outUserName,
378                    java.lang.String outPassword, boolean allowAnonymous,
379                    boolean mailingListActive, boolean mergeWithParentCategory,
380                    com.liferay.portal.service.ServiceContext serviceContext)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException;
383    }