com.liferay.portlet.messageboards.service
Interface MBCategoryService

All Superinterfaces:

BaseService

All Known Implementing Classes:

MBCategoryServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBCategoryService
extends BaseService

The interface for the message boards category remote service.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

MBCategoryServiceUtil, com.liferay.portlet.messageboards.service.base.MBCategoryServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBCategoryServiceImpl

Method Summary

MBCategory	addCategory(long parentCategoryId, String name, String description, String displayStyle, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, ServiceContext serviceContext)
void	deleteCategory(long groupId, long categoryId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<MBCategory>	getCategories(long groupId)
List<MBCategory>	getCategories(long groupId, long[] parentCategoryIds, int start, int end)
List<MBCategory>	getCategories(long groupId, long parentCategoryId, int start, int end)
int	getCategoriesCount(long groupId, long parentCategoryId)
int	getCategoriesCount(long groupId, long[] parentCategoryIds)
MBCategory	getCategory(long categoryId)
long[]	getCategoryIds(long groupId, long categoryId)
List<Long>	getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
List<MBCategory>	getSubscribedCategories(long groupId, long userId, int start, int end)
int	getSubscribedCategoriesCount(long groupId, long userId)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	subscribeCategory(long groupId, long categoryId)
void	unsubscribeCategory(long groupId, long categoryId)
MBCategory	updateCategory(long categoryId, long parentCategoryId, String name, String description, String displayStyle, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, boolean mergeWithParentCategory, ServiceContext serviceContext)

Method Detail

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCategory

MBCategory addCategory(long parentCategoryId,
                       String name,
                       String description,
                       String displayStyle,
                       String emailAddress,
                       String inProtocol,
                       String inServerName,
                       int inServerPort,
                       boolean inUseSSL,
                       String inUserName,
                       String inPassword,
                       int inReadInterval,
                       String outEmailAddress,
                       boolean outCustom,
                       String outServerName,
                       int outServerPort,
                       boolean outUseSSL,
                       String outUserName,
                       String outPassword,
                       boolean mailingListActive,
                       boolean allowAnonymousEmail,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(long groupId,
                    long categoryId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBCategory> getCategories(long groupId)
                               throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBCategory> getCategories(long groupId,
                                                                        long parentCategoryId,
                                                                        int start,
                                                                        int end)
                               throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBCategory> getCategories(long groupId,
                                                                        long[] parentCategoryIds,
                                                                        int start,
                                                                        int end)
                               throws SystemException

Throws:

SystemException

getCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesCount(long groupId,
                                                                long parentCategoryId)
                       throws SystemException

Throws:

SystemException

getCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesCount(long groupId,
                                                                long[] parentCategoryIds)
                       throws SystemException

Throws:

SystemException

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBCategory getCategory(long categoryId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getCategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getCategoryIds(long groupId,
                                                               long categoryId)
                      throws SystemException

Throws:

SystemException

getSubcategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getSubcategoryIds(List<Long> categoryIds,
                                                                      long groupId,
                                                                      long categoryId)
                             throws SystemException

Throws:

SystemException

getSubscribedCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBCategory> getSubscribedCategories(long groupId,
                                                                                  long userId,
                                                                                  int start,
                                                                                  int end)
                                         throws SystemException

Throws:

SystemException

getSubscribedCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSubscribedCategoriesCount(long groupId,
                                                                          long userId)
                                 throws SystemException

Throws:

SystemException

subscribeCategory

void subscribeCategory(long groupId,
                       long categoryId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

unsubscribeCategory

void unsubscribeCategory(long groupId,
                         long categoryId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateCategory

MBCategory updateCategory(long categoryId,
                          long parentCategoryId,
                          String name,
                          String description,
                          String displayStyle,
                          String emailAddress,
                          String inProtocol,
                          String inServerName,
                          int inServerPort,
                          boolean inUseSSL,
                          String inUserName,
                          String inPassword,
                          int inReadInterval,
                          String outEmailAddress,
                          boolean outCustom,
                          String outServerName,
                          int outServerPort,
                          boolean outUseSSL,
                          String outUserName,
                          String outPassword,
                          boolean mailingListActive,
                          boolean allowAnonymousEmail,
                          boolean mergeWithParentCategory,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException