com.liferay.portlet.messageboards.service
Class MBCategoryServiceUtil

java.lang.Object
  com.liferay.portlet.messageboards.service.MBCategoryServiceUtil

public class MBCategoryServiceUtil
extends Object

The utility for the message boards category remote service. This utility wraps com.liferay.portlet.messageboards.service.impl.MBCategoryServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

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:

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

Constructor Summary

MBCategoryServiceUtil()

Method Summary

static 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)
static void	deleteCategory(long groupId, long categoryId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<MBCategory>	getCategories(long groupId)
static List<MBCategory>	getCategories(long groupId, long[] parentCategoryIds, int start, int end)
static List<MBCategory>	getCategories(long groupId, long parentCategoryId, int start, int end)
static int	getCategoriesCount(long groupId, long parentCategoryId)
static int	getCategoriesCount(long groupId, long[] parentCategoryIds)
static MBCategory	getCategory(long categoryId)
static long[]	getCategoryIds(long groupId, long categoryId)
static MBCategoryService	getService()
static List<Long>	getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
static List<MBCategory>	getSubscribedCategories(long groupId, long userId, int start, int end)
static int	getSubscribedCategoriesCount(long groupId, long userId)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(MBCategoryService service) Deprecated.
static void	subscribeCategory(long groupId, long categoryId)
static void	unsubscribeCategory(long groupId, long categoryId)
static 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MBCategoryServiceUtil

public MBCategoryServiceUtil()

Method Detail

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCategory

public static 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

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

Throws:

PortalException

SystemException

getCategories

public static List<MBCategory> getCategories(long groupId)
                                      throws SystemException

Throws:

SystemException

getCategories

public static List<MBCategory> getCategories(long groupId,
                                             long parentCategoryId,
                                             int start,
                                             int end)
                                      throws SystemException

Throws:

SystemException

getCategories

public static List<MBCategory> getCategories(long groupId,
                                             long[] parentCategoryIds,
                                             int start,
                                             int end)
                                      throws SystemException

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long parentCategoryId)
                              throws SystemException

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long[] parentCategoryIds)
                              throws SystemException

Throws:

SystemException

getCategory

public static MBCategory getCategory(long categoryId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getCategoryIds

public static long[] getCategoryIds(long groupId,
                                    long categoryId)
                             throws SystemException

Throws:

SystemException

getSubcategoryIds

public static List<Long> getSubcategoryIds(List<Long> categoryIds,
                                           long groupId,
                                           long categoryId)
                                    throws SystemException

Throws:

SystemException

getSubscribedCategories

public static List<MBCategory> getSubscribedCategories(long groupId,
                                                       long userId,
                                                       int start,
                                                       int end)
                                                throws SystemException

Throws:

SystemException

getSubscribedCategoriesCount

public static int getSubscribedCategoriesCount(long groupId,
                                               long userId)
                                        throws SystemException

Throws:

SystemException

subscribeCategory

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

Throws:

PortalException

SystemException

unsubscribeCategory

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

Throws:

PortalException

SystemException

updateCategory

public static 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

getService

public static MBCategoryService getService()

setService

public void setService(MBCategoryService service)

Deprecated.