com.liferay.portlet.shopping.service.http
Class ShoppingCategoryServiceJSON

java.lang.Object
  extended bycom.liferay.portlet.shopping.service.http.ShoppingCategoryServiceJSON

public class ShoppingCategoryServiceJSON
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.shopping.service.ShoppingCategoryServiceUtil 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.shopping.model.ShoppingCategory, 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.shopping.service.http.ShoppingCategoryJSONSerializer.

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:
ShoppingCategoryServiceUtil, ShoppingCategoryJSONSerializer

Constructor Summary
ShoppingCategoryServiceJSON()
           
 
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.JSONObject getCategory(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

ShoppingCategoryServiceJSON

public ShoppingCategoryServiceJSON()
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 com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

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 com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteCategory

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

getCategory

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

updateCategory

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