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

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

public class MBCategoryServiceJSON
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a JSON utility for the com.liferay.portlet.messageboards.service.MBCategoryServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for JSON to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to a com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.messageboards.model.MBCategory, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.messageboards.service.http.MBCategoryJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
MBCategoryServiceUtil, MBCategoryJSONSerializer

Constructor Summary
MBCategoryServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addCategory(long parentCategoryId, java.lang.String name, java.lang.String description, java.lang.String emailAddress, java.lang.String inProtocol, java.lang.String inServerName, int inServerPort, boolean inUseSSL, java.lang.String inUserName, java.lang.String inPassword, int inReadInterval, java.lang.String outEmailAddress, boolean outCustom, java.lang.String outServerName, int outServerPort, boolean outUseSSL, java.lang.String outUserName, java.lang.String outPassword, boolean mailingListActive, com.liferay.portal.service.ServiceContext serviceContext)
           
static void deleteCategory(long categoryId)
           
static com.liferay.portal.kernel.json.JSONArray getCategories(long groupId, long parentCategoryId, int start, int end)
           
static int getCategoriesCount(long groupId, long parentCategoryId)
           
static com.liferay.portal.kernel.json.JSONObject getCategory(long categoryId)
           
static void subscribeCategory(long categoryId)
           
static void unsubscribeCategory(long categoryId)
           
static com.liferay.portal.kernel.json.JSONObject updateCategory(long categoryId, long parentCategoryId, java.lang.String name, java.lang.String description, java.lang.String emailAddress, java.lang.String inProtocol, java.lang.String inServerName, int inServerPort, boolean inUseSSL, java.lang.String inUserName, java.lang.String inPassword, int inReadInterval, java.lang.String outEmailAddress, boolean outCustom, java.lang.String outServerName, int outServerPort, boolean outUseSSL, java.lang.String outUserName, java.lang.String outPassword, boolean mailingListActive, boolean mergeWithParentCategory)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBCategoryServiceJSON

public MBCategoryServiceJSON()
Method Detail

addCategory

public static com.liferay.portal.kernel.json.JSONObject addCategory(long parentCategoryId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.lang.String emailAddress,
                                                                    java.lang.String inProtocol,
                                                                    java.lang.String inServerName,
                                                                    int inServerPort,
                                                                    boolean inUseSSL,
                                                                    java.lang.String inUserName,
                                                                    java.lang.String inPassword,
                                                                    int inReadInterval,
                                                                    java.lang.String outEmailAddress,
                                                                    boolean outCustom,
                                                                    java.lang.String outServerName,
                                                                    int outServerPort,
                                                                    boolean outUseSSL,
                                                                    java.lang.String outUserName,
                                                                    java.lang.String outPassword,
                                                                    boolean mailingListActive,
                                                                    com.liferay.portal.service.ServiceContext serviceContext)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCategory

public static com.liferay.portal.kernel.json.JSONObject getCategory(long categoryId)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCategories

public static com.liferay.portal.kernel.json.JSONArray getCategories(long groupId,
                                                                     long parentCategoryId,
                                                                     int start,
                                                                     int end)
                                                              throws com.liferay.portal.PortalException,
                                                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long parentCategoryId)
                              throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

subscribeCategory

public static void subscribeCategory(long categoryId)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

unsubscribeCategory

public static void unsubscribeCategory(long categoryId)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateCategory

public static com.liferay.portal.kernel.json.JSONObject updateCategory(long categoryId,
                                                                       long parentCategoryId,
                                                                       java.lang.String name,
                                                                       java.lang.String description,
                                                                       java.lang.String emailAddress,
                                                                       java.lang.String inProtocol,
                                                                       java.lang.String inServerName,
                                                                       int inServerPort,
                                                                       boolean inUseSSL,
                                                                       java.lang.String inUserName,
                                                                       java.lang.String inPassword,
                                                                       int inReadInterval,
                                                                       java.lang.String outEmailAddress,
                                                                       boolean outCustom,
                                                                       java.lang.String outServerName,
                                                                       int outServerPort,
                                                                       boolean outUseSSL,
                                                                       java.lang.String outUserName,
                                                                       java.lang.String outPassword,
                                                                       boolean mailingListActive,
                                                                       boolean mergeWithParentCategory)
                                                                throws com.liferay.portal.PortalException,
                                                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException