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.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            /**
150            * Returns the message boards category with the primary key.
151            *
152            * @param categoryId the primary key of the message boards category
153            * @return the message boards category
154            * @throws PortalException if a message boards category with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.messageboards.model.MBCategory getMBCategory(
159                    long categoryId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns the message boards category with the UUID in the group.
171            *
172            * @param uuid the UUID of message boards category
173            * @param groupId the group id of the message boards category
174            * @return the message boards category
175            * @throws PortalException if a message boards category with the UUID in the group could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.messageboards.model.MBCategory getMBCategoryByUuidAndGroupId(
180                    java.lang.String uuid, long groupId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns a range of all the message boards categories.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param start the lower bound of the range of message boards categories
192            * @param end the upper bound of the range of message boards categories (not inclusive)
193            * @return the range of message boards categories
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getMBCategories(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of message boards categories.
203            *
204            * @return the number of message boards categories
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getMBCategoriesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param mbCategory the message boards category
215            * @return the message boards category that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
219                    com.liferay.portlet.messageboards.model.MBCategory mbCategory)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the message boards category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param mbCategory the message boards category
226            * @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.
227            * @return the message boards category that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.messageboards.model.MBCategory updateMBCategory(
231                    com.liferay.portlet.messageboards.model.MBCategory mbCategory,
232                    boolean merge)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            public com.liferay.portlet.messageboards.model.MBCategory addCategory(
250                    long userId, long parentCategoryId, java.lang.String name,
251                    java.lang.String description, java.lang.String displayStyle,
252                    java.lang.String emailAddress, java.lang.String inProtocol,
253                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
254                    java.lang.String inUserName, java.lang.String inPassword,
255                    int inReadInterval, java.lang.String outEmailAddress,
256                    boolean outCustom, java.lang.String outServerName, int outServerPort,
257                    boolean outUseSSL, java.lang.String outUserName,
258                    java.lang.String outPassword, boolean allowAnonymous,
259                    boolean mailingListActive,
260                    com.liferay.portal.service.ServiceContext serviceContext)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public void addCategoryResources(long categoryId,
265                    boolean addGroupPermissions, boolean addGuestPermissions)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void addCategoryResources(long categoryId,
270                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void addCategoryResources(
275                    com.liferay.portlet.messageboards.model.MBCategory category,
276                    boolean addGroupPermissions, boolean addGuestPermissions)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public void addCategoryResources(
281                    com.liferay.portlet.messageboards.model.MBCategory category,
282                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            public void deleteCategories(long groupId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            public void deleteCategory(long categoryId)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void deleteCategory(
295                    com.liferay.portlet.messageboards.model.MBCategory category)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
301                    long groupId)
302                    throws 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, long parentCategoryId, int start, int end)
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[] parentCategoryIds, int start, int end)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public int getCategoriesCount(long groupId)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public int getCategoriesCount(long groupId, long parentCategoryId)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public int getCategoriesCount(long groupId, long[] parentCategoryIds)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public com.liferay.portlet.messageboards.model.MBCategory getCategory(
328                    long categoryId)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
334                    long companyId, int start, int end)
335                    throws com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public int getCompanyCategoriesCount(long companyId)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public java.util.List<java.lang.Long> getSubcategoryIds(
343                    java.util.List<java.lang.Long> categoryIds, long groupId,
344                    long categoryId)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
349                    long groupId, long userId, int start, int end)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public int getSubscribedCategoriesCount(long groupId, long userId)
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            public void subscribeCategory(long userId, long groupId, long categoryId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException;
359    
360            public void unsubscribeCategory(long userId, long groupId, long categoryId)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException;
363    
364            public com.liferay.portlet.messageboards.model.MBCategory updateCategory(
365                    long categoryId, long parentCategoryId, java.lang.String name,
366                    java.lang.String description, java.lang.String displayStyle,
367                    java.lang.String emailAddress, java.lang.String inProtocol,
368                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
369                    java.lang.String inUserName, java.lang.String inPassword,
370                    int inReadInterval, java.lang.String outEmailAddress,
371                    boolean outCustom, java.lang.String outServerName, int outServerPort,
372                    boolean outUseSSL, java.lang.String outUserName,
373                    java.lang.String outPassword, boolean allowAnonymous,
374                    boolean mailingListActive, boolean mergeWithParentCategory,
375                    com.liferay.portal.service.ServiceContext serviceContext)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException;
378    }