ResourceServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2009 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.portal.service.http; 24 25 import com.liferay.portal.kernel.json.JSONObject; 26 import com.liferay.portal.service.ResourceServiceUtil; 27 28 /** 29 * <a href="ResourceServiceJSON.java.html"><b><i>View Source</i></b></a> 30 * 31 * <p> 32 * ServiceBuilder generated this class. Modifications in this class will be 33 * overwritten the next time is generated. 34 * </p> 35 * 36 * <p> 37 * This class provides a JSON utility for the 38 * <code>com.liferay.portal.service.ResourceServiceUtil</code> 39 * service utility. The static methods of this class calls the same methods of 40 * the service utility. However, the signatures are different because it is 41 * difficult for JSON to support certain types. 42 * </p> 43 * 44 * <p> 45 * ServiceBuilder follows certain rules in translating the methods. For example, 46 * if the method in the service utility returns a <code>java.util.List</code>, 47 * that is translated to a 48 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the 49 * service utility returns a <code>com.liferay.portal.model.Resource</code>, 50 * that is translated to a 51 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON 52 * cannot safely use are skipped. The logic for the translation is encapsulated 53 * in <code>com.liferay.portal.service.http.ResourceJSONSerializer</code>. 54 * </p> 55 * 56 * <p> 57 * This allows you to call the the backend services directly from JavaScript. 58 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a 59 * reference of how that portlet uses the generated JavaScript in 60 * <code>portal-web/docroot/html/js/service.js</code> to call the backend 61 * services directly from JavaScript. 62 * </p> 63 * 64 * <p> 65 * The JSON utility is only generated for remote services. 66 * </p> 67 * 68 * @author Brian Wing Shun Chan 69 * 70 * @see com.liferay.portal.service.ResourceServiceUtil 71 * @see com.liferay.portal.service.http.ResourceJSONSerializer 72 * 73 */ 74 public class ResourceServiceJSON { 75 public static JSONObject getResource(long companyId, java.lang.String name, 76 int scope, java.lang.String primKey) 77 throws com.liferay.portal.PortalException, 78 com.liferay.portal.SystemException { 79 com.liferay.portal.model.Resource returnValue = ResourceServiceUtil.getResource(companyId, 80 name, scope, primKey); 81 82 return ResourceJSONSerializer.toJSONObject(returnValue); 83 } 84 }