Liferay 6.2-ce-ga5

com.liferay.portlet.messageboards.service.http
Class MBCategoryServiceHttp

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.http.MBCategoryServiceHttp

public class MBCategoryServiceHttp
extends Object

Provides the HTTP utility for the MBCategoryServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

See Also:
MBCategoryServiceSoap, HttpPrincipal, MBCategoryServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
MBCategoryServiceHttp()
           
 
Method Summary
static MBCategory addCategory(HttpPrincipal httpPrincipal, long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext)
           
static MBCategory addCategory(HttpPrincipal httpPrincipal, 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(HttpPrincipal httpPrincipal, long categoryId, boolean includeTrashedEntries)
           
static void deleteCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, int status)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds, int start, int end)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds, int status, int start, int end)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId, int start, int end)
           
static List<MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId, int status, int start, int end)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds, int status)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId, int status)
           
static MBCategory getCategory(HttpPrincipal httpPrincipal, long categoryId)
           
static long[] getCategoryIds(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static List<Long> getSubcategoryIds(HttpPrincipal httpPrincipal, List<Long> categoryIds, long groupId, long categoryId)
           
static List<MBCategory> getSubscribedCategories(HttpPrincipal httpPrincipal, long groupId, long userId, int start, int end)
           
static int getSubscribedCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long userId)
           
static MBCategory moveCategory(HttpPrincipal httpPrincipal, long categoryId, long parentCategoryId, boolean mergeWithParentCategory)
           
static MBCategory moveCategoryFromTrash(HttpPrincipal httpPrincipal, long categoryId, long newCategoryId)
           
static MBCategory moveCategoryToTrash(HttpPrincipal httpPrincipal, long categoryId)
           
static void restoreCategoryFromTrash(HttpPrincipal httpPrincipal, long categoryId)
           
static void subscribeCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static void unsubscribeCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static MBCategory updateCategory(HttpPrincipal httpPrincipal, 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

MBCategoryServiceHttp

public MBCategoryServiceHttp()
Method Detail

addCategory

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

addCategory

public static MBCategory addCategory(HttpPrincipal httpPrincipal,
                                     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,
                                     SystemException
Throws:
PortalException
SystemException

deleteCategory

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

deleteCategory

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

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId)
                                      throws SystemException
Throws:
SystemException

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             int status)
                                      throws SystemException
Throws:
SystemException

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long parentCategoryId,
                                             int start,
                                             int end)
                                      throws SystemException
Throws:
SystemException

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long parentCategoryId,
                                             int status,
                                             int start,
                                             int end)
                                      throws SystemException
Throws:
SystemException

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long[] parentCategoryIds,
                                             int start,
                                             int end)
                                      throws SystemException
Throws:
SystemException

getCategories

public static List<MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long[] parentCategoryIds,
                                             int status,
                                             int start,
                                             int end)
                                      throws SystemException
Throws:
SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long parentCategoryId)
                              throws SystemException
Throws:
SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long parentCategoryId,
                                     int status)
                              throws SystemException
Throws:
SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long[] parentCategoryIds)
                              throws SystemException
Throws:
SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long[] parentCategoryIds,
                                     int status)
                              throws SystemException
Throws:
SystemException

getCategory

public static MBCategory getCategory(HttpPrincipal httpPrincipal,
                                     long categoryId)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getCategoryIds

public static long[] getCategoryIds(HttpPrincipal httpPrincipal,
                                    long groupId,
                                    long categoryId)
                             throws SystemException
Throws:
SystemException

getSubcategoryIds

public static List<Long> getSubcategoryIds(HttpPrincipal httpPrincipal,
                                           List<Long> categoryIds,
                                           long groupId,
                                           long categoryId)
                                    throws SystemException
Throws:
SystemException

getSubscribedCategories

public static List<MBCategory> getSubscribedCategories(HttpPrincipal httpPrincipal,
                                                       long groupId,
                                                       long userId,
                                                       int start,
                                                       int end)
                                                throws SystemException
Throws:
SystemException

getSubscribedCategoriesCount

public static int getSubscribedCategoriesCount(HttpPrincipal httpPrincipal,
                                               long groupId,
                                               long userId)
                                        throws SystemException
Throws:
SystemException

moveCategory

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

moveCategoryFromTrash

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

moveCategoryToTrash

public static MBCategory moveCategoryToTrash(HttpPrincipal httpPrincipal,
                                             long categoryId)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

restoreCategoryFromTrash

public static void restoreCategoryFromTrash(HttpPrincipal httpPrincipal,
                                            long categoryId)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

subscribeCategory

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

unsubscribeCategory

public static void unsubscribeCategory(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long categoryId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

updateCategory

public static MBCategory updateCategory(HttpPrincipal httpPrincipal,
                                        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,
                                        SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5