Liferay 7.0-ce-b4

com.liferay.portlet.messageboards.service
Class MBCategoryLocalServiceUtil

java.lang.Object
  extended by 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, ModelPermissions modelPermissions)
           
static void addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addCategoryResources(MBCategory category, ModelPermissions modelPermissions)
           
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 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static MBCategory fetchMBCategory(long categoryId)
           
static MBCategory fetchMBCategoryByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards category matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
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[] excludedCategoryIds, 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<MBCategory> getCategories(long groupId, long excludedCategoryId, long parentCategoryId, int status, int start, int end)
           
static List<Object> getCategoriesAndThreads(long groupId, long categoryId)
           
static List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status)
           
static List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status, int start, int end)
           
static int getCategoriesAndThreadsCount(long groupId, long categoryId)
           
static int getCategoriesAndThreadsCount(long groupId, long categoryId, int status)
           
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[] excludedCategoryIds, long[] parentCategoryIds, int status)
           
static int getCategoriesCount(long groupId, long parentCategoryId, int status)
           
static int getCategoriesCount(long groupId, long excludedCategoryId, 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 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static List<MBCategory> getMBCategories(int start, int end)
          Returns a range of all the message boards categories.
static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the message boards categories matching the UUID and company.
static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBCategory> orderByComparator)
          Returns a range of message boards categories matching the UUID and company.
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 getMBCategoryByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards category matching the UUID and group.
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
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 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 updateMessageCount(long categoryId)
           
static MBCategory updateStatistics(long categoryId)
           
static MBCategory updateStatus(long userId, long categoryId, int status)
           
static MBCategory updateThreadCount(long categoryId)
           
 
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

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
Throws:
PortalException

addCategory

public static MBCategory addCategory(long userId,
                                     long parentCategoryId,
                                     String name,
                                     String description,
                                     ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

addCategoryResources

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

addCategoryResources

public static void addCategoryResources(MBCategory category,
                                        ModelPermissions modelPermissions)
                                 throws PortalException
Throws:
PortalException

addCategoryResources

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

addCategoryResources

public static void addCategoryResources(long categoryId,
                                        ModelPermissions modelPermissions)
                                 throws PortalException
Throws:
PortalException

addMBCategory

public static MBCategory addMBCategory(MBCategory mbCategory)
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

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

deleteCategories

public static void deleteCategories(long groupId)
                             throws PortalException
Throws:
PortalException

deleteCategory

public static void deleteCategory(MBCategory category)
                           throws PortalException
Throws:
PortalException

deleteCategory

public static void deleteCategory(MBCategory category,
                                  boolean includeTrashedEntries)
                           throws PortalException
Throws:
PortalException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws PortalException
Throws:
PortalException

deleteMBCategory

public static MBCategory deleteMBCategory(long categoryId)
                                   throws PortalException
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

deleteMBCategory

public static MBCategory deleteMBCategory(MBCategory mbCategory)
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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
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 com.liferay.portlet.messageboards.model.impl.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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
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 com.liferay.portlet.messageboards.model.impl.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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchMBCategory

public static MBCategory fetchMBCategory(long categoryId)

fetchMBCategoryByUuidAndGroupId

public static MBCategory fetchMBCategoryByUuidAndGroupId(String uuid,
                                                         long groupId)
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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCategories

public static List<MBCategory> getCategories(long groupId)

getCategories

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

getCategories

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

getCategories

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

getCategories

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

getCategories

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

getCategories

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

getCategories

public static List<MBCategory> getCategories(long groupId,
                                             int status)

getCategoriesAndThreads

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

getCategoriesAndThreads

public static List<Object> getCategoriesAndThreads(long groupId,
                                                   long categoryId,
                                                   int status)

getCategoriesAndThreads

public static List<Object> getCategoriesAndThreads(long groupId,
                                                   long categoryId,
                                                   int status,
                                                   int start,
                                                   int end)

getCategoriesAndThreadsCount

public static int getCategoriesAndThreadsCount(long groupId,
                                               long categoryId)

getCategoriesAndThreadsCount

public static int getCategoriesAndThreadsCount(long groupId,
                                               long categoryId,
                                               int status)

getCategoriesCount

public static int getCategoriesCount(long groupId)

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long excludedCategoryId,
                                     long parentCategoryId,
                                     int status)

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long[] excludedCategoryIds,
                                     long[] parentCategoryIds,
                                     int status)

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long parentCategoryId)

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long parentCategoryId,
                                     int status)

getCategoriesCount

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

getCategoriesCount

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

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     int status)

getCategory

public static MBCategory getCategory(long categoryId)
                              throws PortalException
Throws:
PortalException

getCompanyCategories

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

getCompanyCategoriesCount

public static int getCompanyCategoriesCount(long companyId)

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBCategories

public static List<MBCategory> getMBCategories(int start,
                                               int end)
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 com.liferay.portlet.messageboards.model.impl.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

getMBCategoriesByUuidAndCompanyId

public static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid,
                                                                 long companyId)
Returns all the message boards categories matching the UUID and company.

Parameters:
uuid - the UUID of the message boards categories
companyId - the primary key of the company
Returns:
the matching message boards categories, or an empty list if no matches were found

getMBCategoriesByUuidAndCompanyId

public static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid,
                                                                 long companyId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator<MBCategory> orderByComparator)
Returns a range of message boards categories matching the UUID and company.

Parameters:
uuid - the UUID of the message boards categories
companyId - the primary key of the company
start - the lower bound of the range of message boards categories
end - the upper bound of the range of message boards categories (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching message boards categories, or an empty list if no matches were found

getMBCategoriesCount

public static int getMBCategoriesCount()
Returns the number of message boards categories.

Returns:
the number of message boards categories

getMBCategory

public static MBCategory getMBCategory(long categoryId)
                                throws PortalException
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

getMBCategoryByUuidAndGroupId

public static MBCategory getMBCategoryByUuidAndGroupId(String uuid,
                                                       long groupId)
                                                throws PortalException
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

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getSubcategoryIds

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

getSubscribedCategories

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

getSubscribedCategoriesCount

public static int getSubscribedCategoriesCount(long groupId,
                                               long userId)

moveCategoriesToTrash

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

moveCategory

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

moveCategoryFromTrash

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

moveCategoryToTrash

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

restoreCategoryFromTrash

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

subscribeCategory

public static void subscribeCategory(long userId,
                                     long groupId,
                                     long categoryId)
                              throws PortalException
Throws:
PortalException

unsubscribeCategory

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

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
Throws:
PortalException

updateMBCategory

public static MBCategory updateMBCategory(MBCategory mbCategory)
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

updateMessageCount

public static MBCategory updateMessageCount(long categoryId)

updateStatistics

public static MBCategory updateStatistics(long categoryId)

updateStatus

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

updateThreadCount

public static MBCategory updateThreadCount(long categoryId)

getService

public static MBCategoryLocalService getService()

Liferay 7.0-ce-b4