com.liferay.portlet.messageboards.service
Class MBCategoryLocalServiceUtil

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

public class MBCategoryLocalServiceUtil
extends Object

The utility for the message boards category local service. This utility wraps MBCategoryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to MBCategoryLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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.

See Also:

MBCategoryLocalService, MBCategoryLocalServiceBaseImpl, MBCategoryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

MBCategoryLocalServiceUtil()

Method Summary

static MBCategory	addCategory(long userId, long parentCategoryId, String name, String description, 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, ServiceContext serviceContext)
static void	addCategoryResources(long categoryId, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addCategoryResources(long categoryId, String[] communityPermissions, String[] guestPermissions)
static void	addCategoryResources(MBCategory category, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addCategoryResources(MBCategory category, String[] communityPermissions, String[] guestPermissions)
static MBCategory	addMBCategory(MBCategory mbCategory) Adds the message boards category to the database.
static MBCategory	createMBCategory(long categoryId) Creates a new message boards category with the primary key.
static void	deleteCategories(long groupId)
static void	deleteCategory(long categoryId)
static void	deleteCategory(MBCategory category)
static void	deleteMBCategory(long categoryId) Deletes the message boards category with the primary key from the database.
static void	deleteMBCategory(MBCategory mbCategory) Deletes the message boards category from the database.
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
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)
static int	getCategoriesCount(long groupId, long parentCategoryId)
static int	getCategoriesCount(long groupId, long[] parentCategoryIds)
static MBCategory	getCategory(long categoryId)
static List<MBCategory>	getCompanyCategories(long companyId, int start, int end)
static int	getCompanyCategoriesCount(long companyId)
static List<MBCategory>	getMBCategories(int start, int end) Gets a range of all the message boards categories.
static int	getMBCategoriesCount() Gets the number of message boards categories.
static MBCategory	getMBCategory(long categoryId) Gets the message boards category with the primary key.
static MBCategory	getMBCategoryByUuidAndGroupId(String uuid, long groupId) Gets the message boards category with the UUID and group id.
static MBCategoryLocalService	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)
void	setService(MBCategoryLocalService service)
static void	subscribeCategory(long userId, long groupId, long categoryId)
static void	unsubscribeCategory(long userId, long groupId, long categoryId)
static MBCategory	updateCategory(long categoryId, long parentCategoryId, String name, String description, 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 mergeWithParentCategory, ServiceContext serviceContext)
static MBCategory	updateMBCategory(MBCategory mbCategory) Updates the message boards category in the database.
static MBCategory	updateMBCategory(MBCategory mbCategory, boolean merge) Updates the message boards category in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

MBCategoryLocalServiceUtil

public MBCategoryLocalServiceUtil()

Method Detail

addMBCategory

public static MBCategory addMBCategory(MBCategory mbCategory)
                                throws SystemException

Adds the message boards category to the database. Also notifies the appropriate model listeners.

Parameters:

mbCategory - the message boards category to add

Returns:

the message boards category that was added

Throws:

SystemException - if a system exception occurred

createMBCategory

public static MBCategory createMBCategory(long categoryId)

Creates a new message boards category with the primary key. Does not add the message boards category to the database.

Parameters:

categoryId - the primary key for the new message boards category

Returns:

the new message boards category

deleteMBCategory

public static void deleteMBCategory(long categoryId)
                             throws PortalException,
                                    SystemException

Deletes the message boards category with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

categoryId - the primary key of the message boards category to delete

Throws:

PortalException - if a message boards category with the primary key could not be found

SystemException - if a system exception occurred

deleteMBCategory

public static void deleteMBCategory(MBCategory mbCategory)
                             throws SystemException

Deletes the message boards category from the database. Also notifies the appropriate model listeners.

Parameters:

mbCategory - the message boards category to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getMBCategory

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

Gets the message boards category with the primary key.

Parameters:

categoryId - the primary key of the message boards category to get

Returns:

the message boards category

Throws:

PortalException - if a message boards category with the primary key could not be found

SystemException - if a system exception occurred

getMBCategoryByUuidAndGroupId

public static MBCategory getMBCategoryByUuidAndGroupId(String uuid,
                                                       long groupId)
                                                throws PortalException,
                                                       SystemException

Gets the message boards category with the UUID and group id.

Parameters:

uuid - the UUID of message boards category to get

groupId - the group id of the message boards category to get

Returns:

the message boards category

Throws:

PortalException - if a message boards category with the UUID and group id could not be found

SystemException - if a system exception occurred

getMBCategories

public static List<MBCategory> getMBCategories(int start,
                                               int end)
                                        throws SystemException

Gets a range of all the message boards categories.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of message boards categories to return

end - the upper bound of the range of message boards categories to return (not inclusive)

Returns:

the range of message boards categories

Throws:

SystemException - if a system exception occurred

getMBCategoriesCount

public static int getMBCategoriesCount()
                                throws SystemException

Gets the number of message boards categories.

Returns:

the number of message boards categories

Throws:

SystemException - if a system exception occurred

updateMBCategory

public static MBCategory updateMBCategory(MBCategory mbCategory)
                                   throws SystemException

Updates the message boards category in the database. Also notifies the appropriate model listeners.

Parameters:

mbCategory - the message boards category to update

Returns:

the message boards category that was updated

Throws:

SystemException - if a system exception occurred

updateMBCategory

public static MBCategory updateMBCategory(MBCategory mbCategory,
                                          boolean merge)
                                   throws SystemException

Updates the message boards category in the database. Also notifies the appropriate model listeners.

Parameters:

mbCategory - the message boards category to update

merge - whether to merge the message boards category with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the message boards category that was updated

Throws:

SystemException - if a system exception occurred

addCategory

public static MBCategory addCategory(long userId,
                                     long parentCategoryId,
                                     String name,
                                     String description,
                                     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,
                                     ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(long categoryId,
                                        boolean addCommunityPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(long categoryId,
                                        String[] communityPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(MBCategory category,
                                        boolean addCommunityPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(MBCategory category,
                                        String[] communityPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

deleteCategories

public static void deleteCategories(long groupId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteCategory

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

Throws:

PortalException

SystemException

deleteCategory

public static void deleteCategory(MBCategory category)
                           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)
                              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

getCompanyCategories

public static List<MBCategory> getCompanyCategories(long companyId,
                                                    int start,
                                                    int end)
                                             throws SystemException

Throws:

SystemException

getCompanyCategoriesCount

public static int getCompanyCategoriesCount(long companyId)
                                     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 userId,
                                     long groupId,
                                     long categoryId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

unsubscribeCategory

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

Throws:

PortalException

SystemException

updateCategory

public static MBCategory updateCategory(long categoryId,
                                        long parentCategoryId,
                                        String name,
                                        String description,
                                        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 mergeWithParentCategory,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getService

public static MBCategoryLocalService getService()

setService

public void setService(MBCategoryLocalService service)