com.liferay.portlet.messageboards.service
Interface MBCategoryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MBCategoryLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBCategoryLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the message boards category local service.

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:

MBCategoryLocalServiceUtil, com.liferay.portlet.messageboards.service.base.MBCategoryLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBCategoryLocalServiceImpl

Method Summary

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)
void	addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(long categoryId, String[] groupPermissions, String[] guestPermissions)
void	addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(MBCategory category, String[] groupPermissions, String[] guestPermissions)
MBCategory	addMBCategory(MBCategory mbCategory) Adds the message boards category to the database.
MBCategory	createMBCategory(long categoryId) Creates a new message boards category with the primary key.
void	deleteCategories(long groupId)
void	deleteCategory(long categoryId)
void	deleteCategory(MBCategory category)
MBCategory	deleteMBCategory(long categoryId) Deletes the message boards category with the primary key from the database.
MBCategory	deleteMBCategory(MBCategory mbCategory) Deletes the message boards category from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
MBCategory	fetchMBCategory(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)
List<Object>	getCategoriesAndThreads(long groupId, long categoryId)
int	getCategoriesCount(long groupId)
int	getCategoriesCount(long groupId, long parentCategoryId)
int	getCategoriesCount(long groupId, long[] parentCategoryIds)
MBCategory	getCategory(long categoryId)
List<MBCategory>	getCompanyCategories(long companyId, int start, int end)
int	getCompanyCategoriesCount(long companyId)
List<MBCategory>	getMBCategories(int start, int end) Returns a range of all the message boards categories.
int	getMBCategoriesCount() Returns the number of message boards categories.
MBCategory	getMBCategory(long categoryId) Returns the message boards category with the primary key.
MBCategory	getMBCategoryByUuidAndGroupId(String uuid, long groupId) Returns the message boards category with the UUID in the group.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
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 userId, long groupId, long categoryId)
void	unsubscribeCategory(long userId, 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 allowAnonymous, boolean mailingListActive, boolean mergeWithParentCategory, ServiceContext serviceContext)
MBCategory	updateMBCategory(MBCategory mbCategory) Updates the message boards category in the database or adds it if it does not yet exist.
MBCategory	updateMBCategory(MBCategory mbCategory, boolean merge) Updates the message boards category in the database or adds it if it does not yet exist.

Method Detail

addMBCategory

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

fetchMBCategory

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

Throws:

SystemException

getMBCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getMBCategoryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBCategory getMBCategoryByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException,
                                                SystemException

Returns the message boards category with the UUID in the group.

Parameters:

uuid - the UUID of message boards category

groupId - the group id of the message boards category

Returns:

the message boards category

Throws:

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

SystemException - if a system exception occurred

getMBCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

updateMBCategory

MBCategory updateMBCategory(MBCategory mbCategory,
                            boolean merge)
                            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

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

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

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(MBCategory category,
                          String[] groupPermissions,
                          String[] guestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteCategories

void deleteCategories(long groupId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(long categoryId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteCategory

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

getCategoriesAndThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getCategoriesAndThreads(long groupId,
                                                                              long categoryId)
                                     throws SystemException

Throws:

SystemException

getCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesCount(long groupId)
                       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

getCompanyCategories

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

Throws:

SystemException

getCompanyCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyCategoriesCount(long companyId)
                              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 userId,
                       long groupId,
                       long categoryId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

unsubscribeCategory

void unsubscribeCategory(long userId,
                         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 allowAnonymous,
                          boolean mailingListActive,
                          boolean mergeWithParentCategory,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException