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

java.lang.Object
  extended by com.liferay.portlet.wiki.service.http.WikiNodeServiceJSON

public class WikiNodeServiceJSON
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.WikiNodeServiceUtil 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.WikiNode, 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.WikiNodeJSONSerializer.

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:
WikiNodeServiceUtil, WikiNodeJSONSerializer

Constructor Summary
WikiNodeServiceJSON()
           
 
Method Summary
static org.json.JSONObject addNode(long plid, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addNode(long plid, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteNode(long nodeId)
           
static org.json.JSONObject getNode(long nodeId)
           
static org.json.JSONObject getNode(long groupId, java.lang.String name)
           
static void subscribeNode(long nodeId)
           
static void unsubscribeNode(long nodeId)
           
static org.json.JSONObject updateNode(long nodeId, java.lang.String name, java.lang.String description)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WikiNodeServiceJSON

public WikiNodeServiceJSON()
Method Detail

addNode

public static org.json.JSONObject addNode(long plid,
                                          java.lang.String name,
                                          java.lang.String description,
                                          boolean addCommunityPermissions,
                                          boolean addGuestPermissions)
                                   throws java.rmi.RemoteException,
                                          com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addNode

public static org.json.JSONObject addNode(long plid,
                                          java.lang.String name,
                                          java.lang.String description,
                                          java.lang.String[] communityPermissions,
                                          java.lang.String[] guestPermissions)
                                   throws java.rmi.RemoteException,
                                          com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteNode

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

getNode

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

getNode

public static org.json.JSONObject getNode(long groupId,
                                          java.lang.String name)
                                   throws java.rmi.RemoteException,
                                          com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

subscribeNode

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

unsubscribeNode

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

updateNode

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