Liferay 6.0.5

com.liferay.portlet.messageboards.service
Interface MBCategoryLocalService

All Known Implementing Classes:
MBCategoryLocalServiceBaseImpl, MBCategoryLocalServiceImpl, MBCategoryLocalServiceWrapper

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

The interface for the message boards category local service.

Never modify or reference this interface directly. Always use MBCategoryLocalServiceUtil to access the message boards category local service. Add custom service methods to MBCategoryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, MBCategoryLocalServiceBaseImpl, MBCategoryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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)
           
 void addCategoryResources(long categoryId, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 void addCategoryResources(long categoryId, String[] communityPermissions, String[] guestPermissions)
           
 void addCategoryResources(MBCategory category, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 void addCategoryResources(MBCategory category, String[] communityPermissions, 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)
           
 void deleteMBCategory(long categoryId)
          Deletes the message boards category with the primary key from the database.
 void deleteMBCategory(MBCategory mbCategory)
          Deletes the message boards category from the database.
 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)
          Counts the number of rows that match the dynamic query.
 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)
           
 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)
          Gets a range of all the message boards categories.
 int getMBCategoriesCount()
          Gets the number of message boards categories.
 MBCategory getMBCategory(long categoryId)
          Gets the message boards category with the primary key.
 MBCategory getMBCategoryByUuidAndGroupId(String uuid, long groupId)
          Gets the message boards category with the UUID and group id.
 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 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 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)
           
 MBCategory updateMBCategory(MBCategory mbCategory)
          Updates the message boards category in the database.
 MBCategory updateMBCategory(MBCategory mbCategory, boolean merge)
          Updates the message boards category in the database.
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void addCategoryResources(long categoryId,
                          boolean addCommunityPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addCategoryResources

void addCategoryResources(long categoryId,
                          String[] communityPermissions,
                          String[] guestPermissions)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addCategoryResources

void addCategoryResources(MBCategory category,
                          boolean addCommunityPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addCategoryResources

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

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

Liferay 6.0.5