| TagsPropertyServiceJSON.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.portlet.tags.service.http;
24
25 import com.liferay.portlet.tags.service.TagsPropertyServiceUtil;
26
27 import org.json.JSONArray;
28 import org.json.JSONObject;
29
30 /**
31 * <a href="TagsPropertyServiceJSON.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.portlet.tags.service.TagsPropertyServiceUtil</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.portlet.tags.model.TagsProperty</code>, that
50 * is translated to a <code>org.json.JSONObject</code>. Methods that JSON cannot
51 * safely use are skipped. The logic for the translation is encapsulated in <code>com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer</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.portlet.tags.service.TagsPropertyServiceUtil
68 * @see com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer
69 *
70 */
71 public class TagsPropertyServiceJSON {
72 public static JSONObject addProperty(long entryId, java.lang.String key,
73 java.lang.String value)
74 throws com.liferay.portal.SystemException,
75 com.liferay.portal.PortalException, java.rmi.RemoteException {
76 com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryId,
77 key, value);
78
79 return TagsPropertyJSONSerializer.toJSONObject(returnValue);
80 }
81
82 public static JSONObject addProperty(java.lang.String entryName,
83 java.lang.String key, java.lang.String value)
84 throws com.liferay.portal.SystemException,
85 com.liferay.portal.PortalException, java.rmi.RemoteException {
86 com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryName,
87 key, value);
88
89 return TagsPropertyJSONSerializer.toJSONObject(returnValue);
90 }
91
92 public static void deleteProperty(long propertyId)
93 throws com.liferay.portal.SystemException,
94 com.liferay.portal.PortalException, java.rmi.RemoteException {
95 TagsPropertyServiceUtil.deleteProperty(propertyId);
96 }
97
98 public static JSONArray getProperties(long entryId)
99 throws com.liferay.portal.SystemException, java.rmi.RemoteException {
100 java.util.List returnValue = TagsPropertyServiceUtil.getProperties(entryId);
101
102 return TagsPropertyJSONSerializer.toJSONArray(returnValue);
103 }
104
105 public static JSONArray getPropertyValues(long companyId,
106 java.lang.String key)
107 throws com.liferay.portal.SystemException, java.rmi.RemoteException {
108 java.util.List returnValue = TagsPropertyServiceUtil.getPropertyValues(companyId,
109 key);
110
111 return TagsPropertyJSONSerializer.toJSONArray(returnValue);
112 }
113
114 public static JSONObject updateProperty(long propertyId,
115 java.lang.String key, java.lang.String value)
116 throws com.liferay.portal.SystemException,
117 com.liferay.portal.PortalException, java.rmi.RemoteException {
118 com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.updateProperty(propertyId,
119 key, value);
120
121 return TagsPropertyJSONSerializer.toJSONObject(returnValue);
122 }
123 }