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

java.lang.Object
  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 com.liferay.portal.kernel.json.JSONObject	addPage(long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, com.liferay.portal.service.ServiceContext serviceContext)
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	changeParent(long nodeId, java.lang.String title, java.lang.String newParentTitle, com.liferay.portal.service.ServiceContext serviceContext)
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	movePage(long nodeId, java.lang.String title, java.lang.String newTitle, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portal.kernel.json.JSONObject	revertPage(long nodeId, java.lang.String title, double version, com.liferay.portal.service.ServiceContext serviceContext)
static void	subscribePage(long nodeId, java.lang.String title)
static void	unsubscribePage(long nodeId, java.lang.String title)
static com.liferay.portal.kernel.json.JSONObject	updatePage(long nodeId, java.lang.String title, double version, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.String redirectTitle, com.liferay.portal.service.ServiceContext serviceContext)

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 com.liferay.portal.kernel.json.JSONObject addPage(long nodeId,
                                                                java.lang.String title,
                                                                java.lang.String content,
                                                                java.lang.String summary,
                                                                boolean minorEdit,
                                                                com.liferay.portal.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.PortalException,
                                                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

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 com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

changeParent

public static void changeParent(long nodeId,
                                java.lang.String title,
                                java.lang.String newParentTitle,
                                com.liferay.portal.service.ServiceContext serviceContext)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deletePage

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deletePageAttachment

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getNodePages

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

Throws:

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 com.liferay.portal.PortalException,
                                               com.liferay.portal.SystemException

Throws:

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 com.liferay.portal.PortalException,
                                                                com.liferay.portal.SystemException

Throws:

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 com.liferay.portal.PortalException,
                                                                com.liferay.portal.SystemException

Throws:

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 com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

movePage

public static void movePage(long nodeId,
                            java.lang.String title,
                            java.lang.String newTitle,
                            com.liferay.portal.service.ServiceContext serviceContext)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

revertPage

public static com.liferay.portal.kernel.json.JSONObject revertPage(long nodeId,
                                                                   java.lang.String title,
                                                                   double version,
                                                                   com.liferay.portal.service.ServiceContext serviceContext)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

subscribePage

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsubscribePage

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updatePage

public static com.liferay.portal.kernel.json.JSONObject updatePage(long nodeId,
                                                                   java.lang.String title,
                                                                   double version,
                                                                   java.lang.String content,
                                                                   java.lang.String summary,
                                                                   boolean minorEdit,
                                                                   java.lang.String format,
                                                                   java.lang.String parentTitle,
                                                                   java.lang.String redirectTitle,
                                                                   com.liferay.portal.service.ServiceContext serviceContext)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException