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 org.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.messageboards.model.MBCategory, that is translated to a org.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 org.json.JSONObject addCategory(long plid, long parentCategoryId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addCategory(long plid, long parentCategoryId, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteCategory(long categoryId)
           
static org.json.JSONArray getCategories(long groupId, long parentCategoryId, int begin, int end)
           
static int getCategoriesCount(long groupId, long parentCategoryId)
           
static org.json.JSONObject getCategory(long categoryId)
           
static void subscribeCategory(long categoryId)
           
static void unsubscribeCategory(long categoryId)
           
static org.json.JSONObject updateCategory(long categoryId, long parentCategoryId, java.lang.String name, java.lang.String description, 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 org.json.JSONObject addCategory(long plid,
                                              long parentCategoryId,
                                              java.lang.String name,
                                              java.lang.String description,
                                              boolean addCommunityPermissions,
                                              boolean addGuestPermissions)
                                       throws java.rmi.RemoteException,
                                              com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addCategory

public static org.json.JSONObject addCategory(long plid,
                                              long parentCategoryId,
                                              java.lang.String name,
                                              java.lang.String description,
                                              java.lang.String[] communityPermissions,
                                              java.lang.String[] guestPermissions)
                                       throws java.rmi.RemoteException,
                                              com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteCategory

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

getCategory

public static org.json.JSONObject getCategory(long categoryId)
                                       throws java.rmi.RemoteException,
                                              com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCategories

public static org.json.JSONArray getCategories(long groupId,
                                               long parentCategoryId,
                                               int begin,
                                               int end)
                                        throws java.rmi.RemoteException,
                                               com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCategoriesCount

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

subscribeCategory

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

unsubscribeCategory

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

updateCategory

public static org.json.JSONObject updateCategory(long categoryId,
                                                 long parentCategoryId,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 boolean mergeWithParentCategory)
                                          throws java.rmi.RemoteException,
                                                 com.liferay.portal.SystemException,
                                                 com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException