| RegionServiceJSON.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.portal.service.http;
24
25 import com.liferay.portal.service.RegionServiceUtil;
26
27 import org.json.JSONArray;
28 import org.json.JSONObject;
29
30 /**
31 * <a href="RegionServiceJSON.java.html"><b><i>View Source</i></b></a>
32 *
33 * <p>
34 * ServiceBuilder generated this class. Modifications in this class will be
35 * overwritten the next time is generated.
36 * </p>
37 *
38 * <p>
39 * This class provides a JSON utility for the
40 * <code>com.liferay.portal.service.RegionServiceUtil</code>
41 * service utility. The static methods of this class calls the same methods of
42 * the service utility. However, the signatures are different because it is
43 * difficult for JSON to support certain types.
44 * </p>
45 *
46 * <p>
47 * ServiceBuilder follows certain rules in translating the methods. For example,
48 * if the method in the service utility returns a <code>java.util.List</code>,
49 * that is translated to a <code>org.json.JSONArray</code>. If the method in the
50 * service utility returns a <code>com.liferay.portal.model.Region</code>,
51 * that is translated to a <code>org.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.RegionJSONSerializer</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.RegionServiceUtil
71 * @see com.liferay.portal.service.http.RegionJSONSerializer
72 *
73 */
74 public class RegionServiceJSON {
75 public static JSONObject addRegion(long countryId,
76 java.lang.String regionCode, java.lang.String name, boolean active)
77 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
78 com.liferay.portal.PortalException {
79 com.liferay.portal.model.Region returnValue = RegionServiceUtil.addRegion(countryId,
80 regionCode, name, active);
81
82 return RegionJSONSerializer.toJSONObject(returnValue);
83 }
84
85 public static JSONArray getRegions()
86 throws java.rmi.RemoteException, com.liferay.portal.SystemException {
87 java.util.List<com.liferay.portal.model.Region> returnValue = RegionServiceUtil.getRegions();
88
89 return RegionJSONSerializer.toJSONArray(returnValue);
90 }
91
92 public static JSONArray getRegions(long countryId)
93 throws java.rmi.RemoteException, com.liferay.portal.SystemException {
94 java.util.List<com.liferay.portal.model.Region> returnValue = RegionServiceUtil.getRegions(countryId);
95
96 return RegionJSONSerializer.toJSONArray(returnValue);
97 }
98
99 public static JSONArray getRegions(boolean active)
100 throws java.rmi.RemoteException, com.liferay.portal.SystemException {
101 java.util.List<com.liferay.portal.model.Region> returnValue = RegionServiceUtil.getRegions(active);
102
103 return RegionJSONSerializer.toJSONArray(returnValue);
104 }
105
106 public static JSONArray getRegions(long countryId, boolean active)
107 throws java.rmi.RemoteException, com.liferay.portal.SystemException {
108 java.util.List<com.liferay.portal.model.Region> returnValue = RegionServiceUtil.getRegions(countryId,
109 active);
110
111 return RegionJSONSerializer.toJSONArray(returnValue);
112 }
113
114 public static JSONObject getRegion(long regionId)
115 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
116 com.liferay.portal.PortalException {
117 com.liferay.portal.model.Region returnValue = RegionServiceUtil.getRegion(regionId);
118
119 return RegionJSONSerializer.toJSONObject(returnValue);
120 }
121 }