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

java.lang.Object
  extended by com.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 com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.wiki.model.WikiPage, 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.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 void addPageAttachments(long nodeId, java.lang.String title, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files)
           
static void deletePage(long nodeId, java.lang.String title)
           
static void deletePageAttachment(long nodeId, java.lang.String title, java.lang.String fileName)
           
static com.liferay.portal.kernel.json.JSONArray getNodePages(long nodeId, int max)
           
static java.lang.String getNodePagesRSS(long nodeId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static com.liferay.portal.kernel.json.JSONObject getPage(long nodeId, java.lang.String title)
           
static com.liferay.portal.kernel.json.JSONObject getPage(long nodeId, java.lang.String title, double version)
           
static java.lang.String getPagesRSS(long companyId, long nodeId, java.lang.String title, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, java.lang.String locale)
           
static void subscribePage(long nodeId, java.lang.String title)
           
static void unsubscribePage(long nodeId, java.lang.String title)
           
 
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

addPageAttachments

public static void addPageAttachments(long nodeId,
                                      java.lang.String title,
                                      java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files)
                               throws java.rmi.RemoteException,
                                      com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deletePage

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

deletePageAttachment

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

getNodePages

public static com.liferay.portal.kernel.json.JSONArray getNodePages(long nodeId,
                                                                    int max)
                                                             throws java.rmi.RemoteException,
                                                                    com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getNodePagesRSS

public static java.lang.String getNodePagesRSS(long nodeId,
                                               int max,
                                               java.lang.String type,
                                               double version,
                                               java.lang.String displayStyle,
                                               java.lang.String feedURL,
                                               java.lang.String entryURL)
                                        throws java.rmi.RemoteException,
                                               com.liferay.portal.PortalException,
                                               com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getPage

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

getPage

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

getPagesRSS

public static java.lang.String getPagesRSS(long companyId,
                                           long nodeId,
                                           java.lang.String title,
                                           int max,
                                           java.lang.String type,
                                           double version,
                                           java.lang.String displayStyle,
                                           java.lang.String feedURL,
                                           java.lang.String entryURL,
                                           java.lang.String locale)
                                    throws java.rmi.RemoteException,
                                           com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

subscribePage

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

unsubscribePage

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