WikiNodeServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved. 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a copy 5 * of this software and associated documentation files (the "Software"), to deal 6 * in the Software without restriction, including without limitation the rights 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 * copies of the Software, and to permit persons to whom the Software is 9 * furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included in 12 * all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20 * SOFTWARE. 21 */ 22 23 package com.liferay.portlet.wiki.service.http; 24 25 import com.liferay.portlet.wiki.service.WikiNodeServiceUtil; 26 27 import org.json.JSONObject; 28 29 /** 30 * <a href="WikiNodeServiceJSON.java.html"><b><i>View Source</i></b></a> 31 * 32 * <p> 33 * ServiceBuilder generated this class. Modifications in this class will be 34 * overwritten the next time is generated. 35 * </p> 36 * 37 * <p> 38 * This class provides a JSON utility for the 39 * <code>com.liferay.portlet.wiki.service.WikiNodeServiceUtil</code> 40 * service utility. The static methods of this class calls the same methods of 41 * the service utility. However, the signatures are different because it is 42 * difficult for JSON to support certain types. 43 * </p> 44 * 45 * <p> 46 * ServiceBuilder follows certain rules in translating the methods. For example, 47 * if the method in the service utility returns a <code>java.util.List</code>, 48 * that is translated to a <code>org.json.JSONArray</code>. If the method in the 49 * service utility returns a <code>com.liferay.portlet.wiki.model.WikiNode</code>, 50 * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON 51 * cannot safely use are skipped. The logic for the translation is encapsulated 52 * in <code>com.liferay.portlet.wiki.service.http.WikiNodeJSONSerializer</code>. 53 * </p> 54 * 55 * <p> 56 * This allows you to call the the backend services directly from JavaScript. 57 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a 58 * reference of how that portlet uses the generated JavaScript in 59 * <code>portal-web/docroot/html/js/service.js</code> to call the backend 60 * services directly from JavaScript. 61 * </p> 62 * 63 * <p> 64 * The JSON utility is only generated for remote services. 65 * </p> 66 * 67 * @author Brian Wing Shun Chan 68 * 69 * @see com.liferay.portlet.wiki.service.WikiNodeServiceUtil 70 * @see com.liferay.portlet.wiki.service.http.WikiNodeJSONSerializer 71 * 72 */ 73 public class WikiNodeServiceJSON { 74 public static JSONObject addNode(long plid, java.lang.String name, 75 java.lang.String description, boolean addCommunityPermissions, 76 boolean addGuestPermissions) 77 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 78 com.liferay.portal.PortalException { 79 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.addNode(plid, 80 name, description, addCommunityPermissions, addGuestPermissions); 81 82 return WikiNodeJSONSerializer.toJSONObject(returnValue); 83 } 84 85 public static JSONObject addNode(long plid, java.lang.String name, 86 java.lang.String description, java.lang.String[] communityPermissions, 87 java.lang.String[] guestPermissions) 88 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 89 com.liferay.portal.PortalException { 90 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.addNode(plid, 91 name, description, communityPermissions, guestPermissions); 92 93 return WikiNodeJSONSerializer.toJSONObject(returnValue); 94 } 95 96 public static void deleteNode(long nodeId) 97 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 98 com.liferay.portal.PortalException { 99 WikiNodeServiceUtil.deleteNode(nodeId); 100 } 101 102 public static JSONObject getNode(long nodeId) 103 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 104 com.liferay.portal.PortalException { 105 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.getNode(nodeId); 106 107 return WikiNodeJSONSerializer.toJSONObject(returnValue); 108 } 109 110 public static JSONObject getNode(long groupId, java.lang.String name) 111 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 112 com.liferay.portal.PortalException { 113 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.getNode(groupId, 114 name); 115 116 return WikiNodeJSONSerializer.toJSONObject(returnValue); 117 } 118 119 public static void subscribeNode(long nodeId) 120 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 121 com.liferay.portal.PortalException { 122 WikiNodeServiceUtil.subscribeNode(nodeId); 123 } 124 125 public static void unsubscribeNode(long nodeId) 126 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 127 com.liferay.portal.PortalException { 128 WikiNodeServiceUtil.unsubscribeNode(nodeId); 129 } 130 131 public static JSONObject updateNode(long nodeId, java.lang.String name, 132 java.lang.String description) 133 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 134 com.liferay.portal.PortalException { 135 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.updateNode(nodeId, 136 name, description); 137 138 return WikiNodeJSONSerializer.toJSONObject(returnValue); 139 } 140 }