001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 emailAddress,
252                    java.lang.String inProtocol, java.lang.String inServerName,
253                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
254                    java.lang.String inPassword, int inReadInterval,
255                    java.lang.String outEmailAddress, boolean outCustom,
256                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
257                    java.lang.String outUserName, java.lang.String outPassword,
258                    boolean allowAnonymous, boolean mailingListActive,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * @deprecated {@link #addCategory(long, long, String, String, String,
265            String, String, int, boolean, String, String, int, String,
266            boolean, String, int, boolean, String, String, boolean,
267            boolean, ServiceContext)}
268            */
269            public com.liferay.portlet.messageboards.model.MBCategory addCategory(
270                    long userId, long parentCategoryId, java.lang.String name,
271                    java.lang.String description, java.lang.String emailAddress,
272                    java.lang.String inProtocol, java.lang.String inServerName,
273                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
274                    java.lang.String inPassword, int inReadInterval,
275                    java.lang.String outEmailAddress, boolean outCustom,
276                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
277                    java.lang.String outUserName, java.lang.String outPassword,
278                    boolean mailingListActive,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void addCategoryResources(long categoryId,
284                    boolean addCommunityPermissions, boolean addGuestPermissions)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void addCategoryResources(long categoryId,
289                    java.lang.String[] communityPermissions,
290                    java.lang.String[] guestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void addCategoryResources(
295                    com.liferay.portlet.messageboards.model.MBCategory category,
296                    boolean addCommunityPermissions, boolean addGuestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            public void addCategoryResources(
301                    com.liferay.portlet.messageboards.model.MBCategory category,
302                    java.lang.String[] communityPermissions,
303                    java.lang.String[] guestPermissions)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            public void deleteCategories(long groupId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException;
310    
311            public void deleteCategory(long categoryId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            public void deleteCategory(
316                    com.liferay.portlet.messageboards.model.MBCategory category)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
322                    long groupId)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
327                    long groupId, long parentCategoryId, int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(
332                    long groupId, long[] parentCategoryIds, int start, int end)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public int getCategoriesCount(long groupId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public int getCategoriesCount(long groupId, long parentCategoryId)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public int getCategoriesCount(long groupId, long[] parentCategoryIds)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public com.liferay.portlet.messageboards.model.MBCategory getCategory(
349                    long categoryId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException;
352    
353            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
354            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCompanyCategories(
355                    long companyId, int start, int end)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public int getCompanyCategoriesCount(long companyId)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public java.util.List<java.lang.Long> getSubcategoryIds(
364                    java.util.List<java.lang.Long> categoryIds, long groupId,
365                    long categoryId)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(
370                    long groupId, long userId, int start, int end)
371                    throws com.liferay.portal.kernel.exception.SystemException;
372    
373            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
374            public int getSubscribedCategoriesCount(long groupId, long userId)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            public void subscribeCategory(long userId, long groupId, long categoryId)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException;
380    
381            public void unsubscribeCategory(long userId, long groupId, long categoryId)
382                    throws com.liferay.portal.kernel.exception.PortalException,
383                            com.liferay.portal.kernel.exception.SystemException;
384    
385            public com.liferay.portlet.messageboards.model.MBCategory updateCategory(
386                    long categoryId, long parentCategoryId, java.lang.String name,
387                    java.lang.String description, java.lang.String emailAddress,
388                    java.lang.String inProtocol, java.lang.String inServerName,
389                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
390                    java.lang.String inPassword, int inReadInterval,
391                    java.lang.String outEmailAddress, boolean outCustom,
392                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
393                    java.lang.String outUserName, java.lang.String outPassword,
394                    boolean allowAnonymous, boolean mailingListActive,
395                    boolean mergeWithParentCategory,
396                    com.liferay.portal.service.ServiceContext serviceContext)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException;
399    
400            /**
401            * @deprecated {@link #updateCategory(long, long, String, String, String,
402            String, String, int, boolean, String, String, int, String,
403            boolean, String, int, boolean, String, String, boolean,
404            boolean, boolean, ServiceContext)}
405            */
406            public com.liferay.portlet.messageboards.model.MBCategory updateCategory(
407                    long categoryId, long parentCategoryId, java.lang.String name,
408                    java.lang.String description, java.lang.String emailAddress,
409                    java.lang.String inProtocol, java.lang.String inServerName,
410                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
411                    java.lang.String inPassword, int inReadInterval,
412                    java.lang.String outEmailAddress, boolean outCustom,
413                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
414                    java.lang.String outUserName, java.lang.String outPassword,
415                    boolean mailingListActive, boolean mergeWithParentCategory,
416                    com.liferay.portal.service.ServiceContext serviceContext)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    }