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.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
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.portlet.tags.service.TagsPropertyServiceUtil</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.portlet.tags.model.TagsProperty</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.portlet.tags.service.http.TagsPropertyJSONSerializer</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.portlet.tags.service.TagsPropertyServiceUtil
71   * @see com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer
72   *
73   */
74  public class TagsPropertyServiceJSON {
75      public static JSONObject addProperty(long entryId, java.lang.String key,
76          java.lang.String value)
77          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
78              com.liferay.portal.PortalException {
79          com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryId,
80                  key, value);
81  
82          return TagsPropertyJSONSerializer.toJSONObject(returnValue);
83      }
84  
85      public static JSONObject addProperty(java.lang.String entryName,
86          java.lang.String key, java.lang.String value)
87          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
88              com.liferay.portal.PortalException {
89          com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryName,
90                  key, value);
91  
92          return TagsPropertyJSONSerializer.toJSONObject(returnValue);
93      }
94  
95      public static void deleteProperty(long propertyId)
96          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
97              com.liferay.portal.PortalException {
98          TagsPropertyServiceUtil.deleteProperty(propertyId);
99      }
100 
101     public static JSONArray getProperties(long entryId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
103         java.util.List<com.liferay.portlet.tags.model.TagsProperty> returnValue = TagsPropertyServiceUtil.getProperties(entryId);
104 
105         return TagsPropertyJSONSerializer.toJSONArray(returnValue);
106     }
107 
108     public static JSONArray getPropertyValues(long companyId,
109         java.lang.String key)
110         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
111         java.util.List<com.liferay.portlet.tags.model.TagsProperty> returnValue = TagsPropertyServiceUtil.getPropertyValues(companyId,
112                 key);
113 
114         return TagsPropertyJSONSerializer.toJSONArray(returnValue);
115     }
116 
117     public static JSONObject updateProperty(long propertyId,
118         java.lang.String key, java.lang.String value)
119         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
120             com.liferay.portal.PortalException {
121         com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.updateProperty(propertyId,
122                 key, value);
123 
124         return TagsPropertyJSONSerializer.toJSONObject(returnValue);
125     }
126 }