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.portal.kernel.json.JSONObject; 26 27 import com.liferay.portlet.wiki.service.WikiNodeServiceUtil; 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 49 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the 50 * service utility returns a <code>com.liferay.portlet.wiki.model.WikiNode</code>, 51 * that is translated to a 52 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON 53 * cannot safely use are skipped. The logic for the translation is encapsulated 54 * in <code>com.liferay.portlet.wiki.service.http.WikiNodeJSONSerializer</code>. 55 * </p> 56 * 57 * <p> 58 * This allows you to call the the backend services directly from JavaScript. 59 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a 60 * reference of how that portlet uses the generated JavaScript in 61 * <code>portal-web/docroot/html/js/service.js</code> to call the backend 62 * services directly from JavaScript. 63 * </p> 64 * 65 * <p> 66 * The JSON utility is only generated for remote services. 67 * </p> 68 * 69 * @author Brian Wing Shun Chan 70 * 71 * @see com.liferay.portlet.wiki.service.WikiNodeServiceUtil 72 * @see com.liferay.portlet.wiki.service.http.WikiNodeJSONSerializer 73 * 74 */ 75 public class WikiNodeServiceJSON { 76 public static JSONObject addNode(long plid, java.lang.String name, 77 java.lang.String description, boolean addCommunityPermissions, 78 boolean addGuestPermissions) 79 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 80 com.liferay.portal.SystemException { 81 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.addNode(plid, 82 name, description, addCommunityPermissions, addGuestPermissions); 83 84 return WikiNodeJSONSerializer.toJSONObject(returnValue); 85 } 86 87 public static JSONObject addNode(long plid, java.lang.String name, 88 java.lang.String description, java.lang.String[] communityPermissions, 89 java.lang.String[] guestPermissions) 90 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 91 com.liferay.portal.SystemException { 92 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.addNode(plid, 93 name, description, communityPermissions, guestPermissions); 94 95 return WikiNodeJSONSerializer.toJSONObject(returnValue); 96 } 97 98 public static void deleteNode(long nodeId) 99 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 100 com.liferay.portal.SystemException { 101 WikiNodeServiceUtil.deleteNode(nodeId); 102 } 103 104 public static JSONObject getNode(long nodeId) 105 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 106 com.liferay.portal.SystemException { 107 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.getNode(nodeId); 108 109 return WikiNodeJSONSerializer.toJSONObject(returnValue); 110 } 111 112 public static JSONObject getNode(long groupId, java.lang.String name) 113 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 114 com.liferay.portal.SystemException { 115 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.getNode(groupId, 116 name); 117 118 return WikiNodeJSONSerializer.toJSONObject(returnValue); 119 } 120 121 public static void subscribeNode(long nodeId) 122 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 123 com.liferay.portal.SystemException { 124 WikiNodeServiceUtil.subscribeNode(nodeId); 125 } 126 127 public static void unsubscribeNode(long nodeId) 128 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 129 com.liferay.portal.SystemException { 130 WikiNodeServiceUtil.unsubscribeNode(nodeId); 131 } 132 133 public static JSONObject updateNode(long nodeId, java.lang.String name, 134 java.lang.String description) 135 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 136 com.liferay.portal.SystemException { 137 com.liferay.portlet.wiki.model.WikiNode returnValue = WikiNodeServiceUtil.updateNode(nodeId, 138 name, description); 139 140 return WikiNodeJSONSerializer.toJSONObject(returnValue); 141 } 142 }