Liferay 7.0-ce-b4

com.liferay.portlet.messageboards.service
Class MBCategoryServiceUtil

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.MBCategoryServiceUtil

@ProviderType
public class MBCategoryServiceUtil
extends Object

Provides the remote service utility for MBCategory. This utility wraps com.liferay.portlet.messageboards.service.impl.MBCategoryServiceImpl and is the primary access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:
MBCategoryService, com.liferay.portlet.messageboards.service.base.MBCategoryServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBCategoryServiceImpl

Constructor Summary
MBCategoryServiceUtil()
           
 
Method Summary
static MBCategory addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext)
           
static MBCategory addCategory(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 mailingListActive, boolean allowAnonymousEmail, ServiceContext serviceContext)
           
static void deleteCategory(long categoryId, boolean includeTrashedEntries)
           
static void deleteCategory(long groupId, long categoryId)
           
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, 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 long[] getCategoryIds(long groupId, long categoryId)
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static MBCategoryService 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 MBCategory moveCategory(long categoryId, long parentCategoryId, boolean mergeWithParentCategory)
           
static MBCategory moveCategoryFromTrash(long categoryId, long newCategoryId)
           
static MBCategory moveCategoryToTrash(long categoryId)
           
static void restoreCategoryFromTrash(long categoryId)
           
static void subscribeCategory(long groupId, long categoryId)
           
static void unsubscribeCategory(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 mailingListActive, boolean allowAnonymousEmail, boolean mergeWithParentCategory, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBCategoryServiceUtil

public MBCategoryServiceUtil()
Method Detail

addCategory

public static MBCategory addCategory(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 mailingListActive,
                                     boolean allowAnonymousEmail,
                                     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

deleteCategory

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

deleteCategory

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

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

getCategory

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

getCategoryIds

public static long[] getCategoryIds(long groupId,
                                    long categoryId)

getOSGiServiceIdentifier

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

Returns:
the OSGi service identifier

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)

moveCategory

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

moveCategoryFromTrash

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

moveCategoryToTrash

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

restoreCategoryFromTrash

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

subscribeCategory

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

unsubscribeCategory

public static void unsubscribeCategory(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 mailingListActive,
                                        boolean allowAnonymousEmail,
                                        boolean mergeWithParentCategory,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

getService

public static MBCategoryService getService()

Liferay 7.0-ce-b4