AddressServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2007 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.service.AddressServiceUtil; 26 27 import org.json.JSONArray; 28 import org.json.JSONObject; 29 30 /** 31 * <a href="AddressServiceJSON.java.html"><b><i>View Source</i></b></a> 32 * 33 * <p> 34 * ServiceBuilder generated this class. Modifications in this class will be overwritten 35 * the next time is generated. 36 * </p> 37 * 38 * <p> 39 * This class provides a JSON utility for the <code>com.liferay.portal.service.AddressServiceUtil</code> 40 * service utility. The static methods of this class calls the same methods of the 41 * service utility. However, the signatures are different because it is difficult 42 * 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>, that 48 * is translated to a <code>org.json.JSONArray</code>. If the method in the service 49 * utility returns a <code>com.liferay.portal.model.Address</code>, that is translated 50 * to a <code>org.json.JSONObject</code>. Methods that JSON cannot safely use are 51 * skipped. The logic for the translation is encapsulated in <code>com.liferay.portal.service.http.AddressJSONSerializer</code>. 52 * </p> 53 * 54 * <p> 55 * This allows you to call the the backend services directly from JavaScript. See 56 * <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a reference 57 * of how that portlet uses the generated JavaScript in <code>portal-web/docroot/html/js/service.js</code> 58 * to call the backend services directly from JavaScript. 59 * </p> 60 * 61 * <p> 62 * The JSON utility is only generated for remote services. 63 * </p> 64 * 65 * @author Brian Wing Shun Chan 66 * 67 * @see com.liferay.portal.service.AddressServiceUtil 68 * @see com.liferay.portal.service.http.AddressJSONSerializer 69 * 70 */ 71 public class AddressServiceJSON { 72 public static JSONObject addAddress(java.lang.String className, 73 long classPK, java.lang.String street1, java.lang.String street2, 74 java.lang.String street3, java.lang.String city, java.lang.String zip, 75 long regionId, long countryId, int typeId, boolean mailing, 76 boolean primary) 77 throws com.liferay.portal.SystemException, 78 com.liferay.portal.PortalException, java.rmi.RemoteException { 79 com.liferay.portal.model.Address returnValue = AddressServiceUtil.addAddress(className, 80 classPK, street1, street2, street3, city, zip, regionId, 81 countryId, typeId, mailing, primary); 82 83 return AddressJSONSerializer.toJSONObject(returnValue); 84 } 85 86 public static void deleteAddress(long addressId) 87 throws com.liferay.portal.SystemException, 88 com.liferay.portal.PortalException, java.rmi.RemoteException { 89 AddressServiceUtil.deleteAddress(addressId); 90 } 91 92 public static JSONObject getAddress(long addressId) 93 throws com.liferay.portal.SystemException, 94 com.liferay.portal.PortalException, java.rmi.RemoteException { 95 com.liferay.portal.model.Address returnValue = AddressServiceUtil.getAddress(addressId); 96 97 return AddressJSONSerializer.toJSONObject(returnValue); 98 } 99 100 public static JSONArray getAddresses(java.lang.String className, 101 long classPK) 102 throws com.liferay.portal.SystemException, 103 com.liferay.portal.PortalException, java.rmi.RemoteException { 104 java.util.List returnValue = AddressServiceUtil.getAddresses(className, 105 classPK); 106 107 return AddressJSONSerializer.toJSONArray(returnValue); 108 } 109 110 public static JSONObject updateAddress(long addressId, 111 java.lang.String street1, java.lang.String street2, 112 java.lang.String street3, java.lang.String city, java.lang.String zip, 113 long regionId, long countryId, int typeId, boolean mailing, 114 boolean primary) 115 throws com.liferay.portal.SystemException, 116 com.liferay.portal.PortalException, java.rmi.RemoteException { 117 com.liferay.portal.model.Address returnValue = AddressServiceUtil.updateAddress(addressId, 118 street1, street2, street3, city, zip, regionId, countryId, 119 typeId, mailing, primary); 120 121 return AddressJSONSerializer.toJSONObject(returnValue); 122 } 123 }