com.liferay.portal.service.http
Class WebsiteServiceJSON

java.lang.Object
  extended by com.liferay.portal.service.http.WebsiteServiceJSON

public class WebsiteServiceJSON
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.portal.service.WebsiteServiceUtil 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.portal.model.Website, 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.portal.service.http.WebsiteJSONSerializer.

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:
WebsiteServiceUtil, WebsiteJSONSerializer

Constructor Summary
WebsiteServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addWebsite(java.lang.String className, long classPK, java.lang.String url, int typeId, boolean primary)
           
static void deleteWebsite(long websiteId)
           
static com.liferay.portal.kernel.json.JSONObject getWebsite(long websiteId)
           
static com.liferay.portal.kernel.json.JSONArray getWebsites(java.lang.String className, long classPK)
           
static com.liferay.portal.kernel.json.JSONObject updateWebsite(long websiteId, java.lang.String url, int typeId, boolean primary)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebsiteServiceJSON

public WebsiteServiceJSON()
Method Detail

addWebsite

public static com.liferay.portal.kernel.json.JSONObject addWebsite(java.lang.String className,
                                                                   long classPK,
                                                                   java.lang.String url,
                                                                   int typeId,
                                                                   boolean primary)
                                                            throws java.rmi.RemoteException,
                                                                   com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteWebsite

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

getWebsite

public static com.liferay.portal.kernel.json.JSONObject getWebsite(long websiteId)
                                                            throws java.rmi.RemoteException,
                                                                   com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getWebsites

public static com.liferay.portal.kernel.json.JSONArray getWebsites(java.lang.String className,
                                                                   long classPK)
                                                            throws java.rmi.RemoteException,
                                                                   com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateWebsite

public static com.liferay.portal.kernel.json.JSONObject updateWebsite(long websiteId,
                                                                      java.lang.String url,
                                                                      int typeId,
                                                                      boolean primary)
                                                               throws java.rmi.RemoteException,
                                                                      com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException