com.liferay.portlet.wiki.service.http
Class WikiPageServiceJSON

java.lang.Object
  extended bycom.liferay.portlet.wiki.service.http.WikiPageServiceJSON

public class WikiPageServiceJSON
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.wiki.service.WikiPageServiceUtil 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.wiki.model.WikiPage, 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.wiki.service.http.WikiPageJSONSerializer.

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:
WikiPageServiceUtil, WikiPageJSONSerializer

Constructor Summary
WikiPageServiceJSON()
           
 
Method Summary
static org.json.JSONObject addPage(long nodeId, java.lang.String title)
           
static void deletePage(long nodeId, java.lang.String title)
           
static org.json.JSONObject getPage(long nodeId, java.lang.String title)
           
static org.json.JSONObject getPage(long nodeId, java.lang.String title, double version)
           
static org.json.JSONObject revertPage(long nodeId, java.lang.String title, double version)
           
static org.json.JSONObject updatePage(long nodeId, java.lang.String title, java.lang.String content, java.lang.String format, java.lang.String[] tagsEntries)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WikiPageServiceJSON

public WikiPageServiceJSON()
Method Detail

addPage

public static org.json.JSONObject addPage(long nodeId,
                                          java.lang.String title)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deletePage

public static void deletePage(long nodeId,
                              java.lang.String title)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getPage

public static org.json.JSONObject getPage(long nodeId,
                                          java.lang.String title)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getPage

public static org.json.JSONObject getPage(long nodeId,
                                          java.lang.String title,
                                          double version)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

revertPage

public static org.json.JSONObject revertPage(long nodeId,
                                             java.lang.String title,
                                             double version)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updatePage

public static org.json.JSONObject updatePage(long nodeId,
                                             java.lang.String title,
                                             java.lang.String content,
                                             java.lang.String format,
                                             java.lang.String[] tagsEntries)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException