PhoneServiceJSON.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.JSONArray; 26 import com.liferay.portal.kernel.json.JSONObject; 27 import com.liferay.portal.service.PhoneServiceUtil; 28 29 /** 30 * <a href="PhoneServiceJSON.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.portal.service.PhoneServiceUtil</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.portal.model.Phone</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.portal.service.http.PhoneJSONSerializer</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.portal.service.PhoneServiceUtil 72 * @see com.liferay.portal.service.http.PhoneJSONSerializer 73 * 74 */ 75 public class PhoneServiceJSON { 76 public static JSONObject addPhone(java.lang.String className, long classPK, 77 java.lang.String number, java.lang.String extension, int typeId, 78 boolean primary) 79 throws com.liferay.portal.PortalException, 80 com.liferay.portal.SystemException { 81 com.liferay.portal.model.Phone returnValue = PhoneServiceUtil.addPhone(className, 82 classPK, number, extension, typeId, primary); 83 84 return PhoneJSONSerializer.toJSONObject(returnValue); 85 } 86 87 public static void deletePhone(long phoneId) 88 throws com.liferay.portal.PortalException, 89 com.liferay.portal.SystemException { 90 PhoneServiceUtil.deletePhone(phoneId); 91 } 92 93 public static JSONObject getPhone(long phoneId) 94 throws com.liferay.portal.PortalException, 95 com.liferay.portal.SystemException { 96 com.liferay.portal.model.Phone returnValue = PhoneServiceUtil.getPhone(phoneId); 97 98 return PhoneJSONSerializer.toJSONObject(returnValue); 99 } 100 101 public static JSONArray getPhones(java.lang.String className, long classPK) 102 throws com.liferay.portal.PortalException, 103 com.liferay.portal.SystemException { 104 java.util.List<com.liferay.portal.model.Phone> returnValue = PhoneServiceUtil.getPhones(className, 105 classPK); 106 107 return PhoneJSONSerializer.toJSONArray(returnValue); 108 } 109 110 public static JSONObject updatePhone(long phoneId, java.lang.String number, 111 java.lang.String extension, int typeId, boolean primary) 112 throws com.liferay.portal.PortalException, 113 com.liferay.portal.SystemException { 114 com.liferay.portal.model.Phone returnValue = PhoneServiceUtil.updatePhone(phoneId, 115 number, extension, typeId, primary); 116 117 return PhoneJSONSerializer.toJSONObject(returnValue); 118 } 119 }