Class MBCategoryLocalServiceUtil

java.lang.Object
com.liferay.message.boards.service.MBCategoryLocalServiceUtil

public class MBCategoryLocalServiceUtil extends Object
Provides the local service utility for MBCategory. This utility wraps com.liferay.message.boards.service.impl.MBCategoryLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • MBCategoryLocalServiceUtil

      public MBCategoryLocalServiceUtil()
  • Method Details

    • addCategory

      public static MBCategory addCategory(String externalReferenceCode, long userId, long parentCategoryId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCategory

      public static MBCategory addCategory(String externalReferenceCode, 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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCategoryResources

      public static void addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCategoryResources

      public static void addCategoryResources(long categoryId, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCategoryResources

      public static void addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCategoryResources

      public static void addCategoryResources(MBCategory category, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addMBCategory

      public static MBCategory addMBCategory(MBCategory mbCategory)
      Adds the message boards category to the database. Also notifies the appropriate model listeners.

      Important: Inspect MBCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCategories

      public static void deleteCategories(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCategory

      public static void deleteCategory(long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCategory

      public static void deleteCategory(MBCategory category) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCategory

      public static void deleteCategory(MBCategory category, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCategoryByExternalReferenceCode

      public static void deleteCategoryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteMBCategory

      public static MBCategory deleteMBCategory(long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the message boards category with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect MBCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      categoryId - the primary key of the message boards category
      Returns:
      the message boards category that was removed
      Throws:
      com.liferay.portal.kernel.exception.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.

      Important: Inspect MBCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      mbCategory - the message boards category
      Returns:
      the message boards category that was removed
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.message.boards.model.impl.MBCategoryModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.message.boards.model.impl.MBCategoryModelImpl.

      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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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)
    • fetchMBCategory

      public static MBCategory fetchMBCategory(long groupId, String friendlyURL)
    • fetchMBCategoryByExternalReferenceCode

      public static MBCategory fetchMBCategoryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCategories

      public static List<MBCategory> getCategories(long groupId)
    • getCategories

      public static List<MBCategory> getCategories(long groupId, int status)
    • 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 excludedCategoryId, 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, long[] excludedCategoryIds, long[] parentCategoryIds, int status, int start, int end)
    • 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, 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 excludedCategoryId, 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, long[] excludedCategoryIds, long[] parentCategoryIds, int status)
    • getCategory

      public static MBCategory getCategory(long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyCategories

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

      public static int getCompanyCategoriesCount(long companyId)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.message.boards.model.impl.MBCategoryModelImpl.

      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, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.PortalException - if a message boards category with the primary key could not be found
    • getMBCategory

      public static MBCategory getMBCategory(long groupId, String friendlyURL) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getMBCategoryByExternalReferenceCode

      public static MBCategory getMBCategoryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getMBCategoryByUuidAndGroupId

      public static MBCategory getMBCategoryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveCategory

      public static MBCategory moveCategory(long categoryId, long parentCategoryId, boolean mergeWithParentCategory) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveCategoryFromTrash

      public static MBCategory moveCategoryFromTrash(long userId, long categoryId, long newCategoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveCategoryToTrash

      public static MBCategory moveCategoryToTrash(long userId, long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreCategoryFromTrash

      public static void restoreCategoryFromTrash(long userId, long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • subscribeCategory

      public static void subscribeCategory(long userId, long groupId, long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsubscribeCategory

      public static void unsubscribeCategory(long userId, long groupId, long categoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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.

      Important: Inspect MBCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      mbCategory - the message boards category
      Returns:
      the message boards category that was updated
    • updateStatus

      public static MBCategory updateStatus(long userId, long categoryId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static MBCategoryLocalService getService()