com.liferay.portlet.messageboards.service
Class MBCategoryLocalServiceUtil

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

@ProviderType
public class MBCategoryLocalServiceUtil
extends Object

Provides the local service utility for MBCategory. This utility wraps com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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, com.liferay.portlet.messageboards.service.base.MBCategoryLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl

Constructor Summary

MBCategoryLocalServiceUtil()

Method Summary

static MBCategory	addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext)
static MBCategory	addCategory(long userId, 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 allowAnonymous, boolean mailingListActive, ServiceContext serviceContext)
static void	addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addCategoryResources(long categoryId, String[] groupPermissions, String[] guestPermissions)
static void	addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addCategoryResources(MBCategory category, String[] groupPermissions, 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	deleteCategory(MBCategory category, boolean includeTrashedEntries)
static MBCategory	deleteMBCategory(long categoryId) Deletes the message boards category with the primary key from the database.
static MBCategory	deleteMBCategory(MBCategory mbCategory) Deletes the message boards category from the database.
static DynamicQuery	dynamicQuery()
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) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static MBCategory	fetchMBCategory(long categoryId)
static MBCategory	fetchMBCategoryByUuidAndCompanyId(String uuid, long companyId) Returns the message boards category with the matching UUID and company.
static MBCategory	fetchMBCategoryByUuidAndGroupId(String uuid, long groupId) Returns the message boards category matching the UUID and group.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<MBCategory>	getCategories(long groupId)
static List<MBCategory>	getCategories(long groupId, int status)
static List<MBCategory>	getCategories(long groupId, long[] parentCategoryIds, int start, int end)
static List<MBCategory>	getCategories(long groupId, long[] parentCategoryIds, int status, int start, int end)
static List<MBCategory>	getCategories(long groupId, long parentCategoryId, int start, int end)
static List<MBCategory>	getCategories(long groupId, long parentCategoryId, int status, int start, int end)
static List<Object>	getCategoriesAndThreads(long groupId, long categoryId)
static int	getCategoriesCount(long groupId)
static int	getCategoriesCount(long groupId, int status)
static int	getCategoriesCount(long groupId, long parentCategoryId)
static int	getCategoriesCount(long groupId, long[] parentCategoryIds)
static int	getCategoriesCount(long groupId, long[] parentCategoryIds, int status)
static int	getCategoriesCount(long groupId, long parentCategoryId, int status)
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) Returns a range of all the message boards categories.
static int	getMBCategoriesCount() Returns the number of message boards categories.
static MBCategory	getMBCategory(long categoryId) Returns the message boards category with the primary key.
static MBCategory	getMBCategoryByUuidAndCompanyId(String uuid, long companyId) Returns the message boards category with the matching UUID and company.
static MBCategory	getMBCategoryByUuidAndGroupId(String uuid, long groupId) Returns the message boards category matching the UUID and group.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
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)
static void	moveCategoriesToTrash(long groupId, long userId)
static MBCategory	moveCategory(long categoryId, long parentCategoryId, boolean mergeWithParentCategory)
static MBCategory	moveCategoryFromTrash(long userId, long categoryId, long newCategoryId)
static MBCategory	moveCategoryToTrash(long userId, long categoryId)
static void	restoreCategoryFromTrash(long userId, long categoryId)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(MBCategoryLocalService service) Deprecated. As of 6.2.0
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 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 allowAnonymous, boolean mailingListActive, boolean mergeWithParentCategory, ServiceContext serviceContext)
static MBCategory	updateMBCategory(MBCategory mbCategory) Updates the message boards category in the database or adds it if it does not yet exist.
static MBCategory	updateStatus(long userId, long categoryId, int status)

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

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 MBCategory 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

Returns:

the message boards category that was removed

Throws:

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

SystemException - if a system exception occurred

deleteMBCategory

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

Returns:

the message boards category that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

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

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from MBCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from MBCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchMBCategory

public static MBCategory fetchMBCategory(long categoryId)
                                  throws SystemException

Throws:

SystemException

fetchMBCategoryByUuidAndCompanyId

public static MBCategory fetchMBCategoryByUuidAndCompanyId(String uuid,
                                                           long companyId)
                                                    throws SystemException

Returns the message boards category with the matching UUID and company.

Parameters:

uuid - the message boards category's UUID

companyId - the primary key of the company

Returns:

the matching message boards category, or null if a matching message boards category could not be found

Throws:

SystemException - if a system exception occurred

fetchMBCategoryByUuidAndGroupId

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

Returns the message boards category matching the UUID and group.

Parameters:

uuid - the message boards category's UUID

groupId - the primary key of the group

Returns:

the matching message boards category, or null if a matching message boards category could not be found

Throws:

SystemException - if a system exception occurred

getMBCategory

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

Returns the message boards category with the primary key.

Parameters:

categoryId - the primary key of the message boards category

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

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getMBCategoryByUuidAndCompanyId

public static MBCategory getMBCategoryByUuidAndCompanyId(String uuid,
                                                         long companyId)
                                                  throws PortalException,
                                                         SystemException

Returns the message boards category with the matching UUID and company.

Parameters:

uuid - the message boards category's UUID

companyId - the primary key of the company

Returns:

the matching message boards category

Throws:

PortalException - if a matching message boards category could not be found

SystemException - if a system exception occurred

getMBCategoryByUuidAndGroupId

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

Returns the message boards category matching the UUID and group.

Parameters:

uuid - the message boards category's UUID

groupId - the primary key of the group

Returns:

the matching message boards category

Throws:

PortalException - if a matching message boards category could not be found

SystemException - if a system exception occurred

getMBCategories

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

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from MBCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

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

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

Returns:

the range of message boards categories

Throws:

SystemException - if a system exception occurred

getMBCategoriesCount

public static int getMBCategoriesCount()
                                throws SystemException

Returns 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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

mbCategory - the message boards category

Returns:

the message boards category that was updated

Throws:

SystemException - if a system exception occurred

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

Throws:

PortalException

SystemException

addCategory

public static MBCategory addCategory(long userId,
                                     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 allowAnonymous,
                                     boolean mailingListActive,
                                     ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(MBCategory category,
                                        String[] groupPermissions,
                                        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

deleteCategory

public static void deleteCategory(MBCategory category,
                                  boolean includeTrashedEntries)
                           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,
                                             int status)
                                      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 parentCategoryId,
                                             int status,
                                             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

getCategories

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

Throws:

SystemException

getCategoriesAndThreads

public static List<Object> getCategoriesAndThreads(long groupId,
                                                   long categoryId)
                                            throws SystemException

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId)
                              throws SystemException

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     int status)
                              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 parentCategoryId,
                                     int status)
                              throws SystemException

Throws:

SystemException

getCategoriesCount

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

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long[] parentCategoryIds,
                                     int status)
                              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

moveCategoriesToTrash

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

Throws:

PortalException

SystemException

moveCategory

public static MBCategory moveCategory(long categoryId,
                                      long parentCategoryId,
                                      boolean mergeWithParentCategory)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

moveCategoryFromTrash

public static MBCategory moveCategoryFromTrash(long userId,
                                               long categoryId,
                                               long newCategoryId)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

moveCategoryToTrash

public static MBCategory moveCategoryToTrash(long userId,
                                             long categoryId)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

restoreCategoryFromTrash

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

Throws:

PortalException

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 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 allowAnonymous,
                                        boolean mailingListActive,
                                        boolean mergeWithParentCategory,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

updateStatus

public static MBCategory updateStatus(long userId,
                                      long categoryId,
                                      int status)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getService

public static MBCategoryLocalService getService()

setService

public void setService(MBCategoryLocalService service)

Deprecated. As of 6.2.0