1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.tags.service.http;
21  
22  import com.liferay.portal.kernel.json.JSONArray;
23  import com.liferay.portal.kernel.json.JSONObject;
24  
25  import com.liferay.portlet.tags.service.TagsPropertyServiceUtil;
26  
27  /**
28   * <a href="TagsPropertyServiceJSON.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This class provides a JSON utility for the
37   * <code>com.liferay.portlet.tags.service.TagsPropertyServiceUtil</code>
38   * service utility. The static methods of this class calls the same methods of
39   * the service utility. However, the signatures are different because it is
40   * difficult for JSON to support certain types.
41   * </p>
42   *
43   * <p>
44   * ServiceBuilder follows certain rules in translating the methods. For example,
45   * if the method in the service utility returns a <code>java.util.List</code>,
46   * that is translated to a
47   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
48   * service utility returns a <code>com.liferay.portlet.tags.model.TagsProperty</code>,
49   * that is translated to a
50   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
51   * cannot safely use are skipped. The logic for the translation is encapsulated
52   * in <code>com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer</code>.
53   * </p>
54   *
55   * <p>
56   * This allows you to call the the backend services directly from JavaScript.
57   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
58   * reference of how that portlet uses the generated JavaScript in
59   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
60   * services directly from JavaScript.
61   * </p>
62   *
63   * <p>
64   * The JSON utility is only generated for remote services.
65   * </p>
66   *
67   * @author Brian Wing Shun Chan
68   *
69   * @see com.liferay.portlet.tags.service.TagsPropertyServiceUtil
70   * @see com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer
71   *
72   */
73  public class TagsPropertyServiceJSON {
74      public static JSONObject addProperty(long entryId, java.lang.String key,
75          java.lang.String value)
76          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
77              com.liferay.portal.SystemException {
78          com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryId,
79                  key, value);
80  
81          return TagsPropertyJSONSerializer.toJSONObject(returnValue);
82      }
83  
84      public static JSONObject addProperty(java.lang.String entryName,
85          java.lang.String key, java.lang.String value)
86          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
87              com.liferay.portal.SystemException {
88          com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.addProperty(entryName,
89                  key, value);
90  
91          return TagsPropertyJSONSerializer.toJSONObject(returnValue);
92      }
93  
94      public static void deleteProperty(long propertyId)
95          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
96              com.liferay.portal.SystemException {
97          TagsPropertyServiceUtil.deleteProperty(propertyId);
98      }
99  
100     public static JSONArray getProperties(long entryId)
101         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
102         java.util.List<com.liferay.portlet.tags.model.TagsProperty> returnValue = TagsPropertyServiceUtil.getProperties(entryId);
103 
104         return TagsPropertyJSONSerializer.toJSONArray(returnValue);
105     }
106 
107     public static JSONArray getPropertyValues(long companyId,
108         java.lang.String key)
109         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
110         java.util.List<com.liferay.portlet.tags.model.TagsProperty> returnValue = TagsPropertyServiceUtil.getPropertyValues(companyId,
111                 key);
112 
113         return TagsPropertyJSONSerializer.toJSONArray(returnValue);
114     }
115 
116     public static JSONObject updateProperty(long propertyId,
117         java.lang.String key, java.lang.String value)
118         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException {
120         com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil.updateProperty(propertyId,
121                 key, value);
122 
123         return TagsPropertyJSONSerializer.toJSONObject(returnValue);
124     }
125 }