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.TagsEntryServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="TagsEntryServiceJSON.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.TagsEntryServiceUtil</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.TagsEntry</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.TagsEntryJSONSerializer</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.TagsEntryServiceUtil
68   * @see com.liferay.portlet.tags.service.http.TagsEntryJSONSerializer
69   *
70   */
71  public class TagsEntryServiceJSON {
72      public static JSONObject addEntry(java.lang.String name)
73          throws com.liferay.portal.SystemException, 
74              com.liferay.portal.PortalException, java.rmi.RemoteException {
75          com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.addEntry(name);
76  
77          return TagsEntryJSONSerializer.toJSONObject(returnValue);
78      }
79  
80      public static JSONObject addEntry(java.lang.String name,
81          java.lang.String[] properties)
82          throws com.liferay.portal.SystemException, 
83              com.liferay.portal.PortalException, java.rmi.RemoteException {
84          com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.addEntry(name,
85                  properties);
86  
87          return TagsEntryJSONSerializer.toJSONObject(returnValue);
88      }
89  
90      public static void deleteEntry(long entryId)
91          throws com.liferay.portal.SystemException, 
92              com.liferay.portal.PortalException, java.rmi.RemoteException {
93          TagsEntryServiceUtil.deleteEntry(entryId);
94      }
95  
96      public static JSONArray getEntries(java.lang.String className, long classPK)
97          throws com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException, java.rmi.RemoteException {
99          java.util.List returnValue = TagsEntryServiceUtil.getEntries(className,
100                 classPK);
101 
102         return TagsEntryJSONSerializer.toJSONArray(returnValue);
103     }
104 
105     public static JSONArray search(long companyId, java.lang.String name,
106         java.lang.String[] properties)
107         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
108         java.util.List returnValue = TagsEntryServiceUtil.search(companyId,
109                 name, properties);
110 
111         return TagsEntryJSONSerializer.toJSONArray(returnValue);
112     }
113 
114     public static JSONArray search(long companyId, java.lang.String name,
115         java.lang.String[] properties, int begin, int end)
116         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
117         java.util.List returnValue = TagsEntryServiceUtil.search(companyId,
118                 name, properties, begin, end);
119 
120         return TagsEntryJSONSerializer.toJSONArray(returnValue);
121     }
122 
123     public static JSONArray searchAutocomplete(long companyId,
124         java.lang.String name, java.lang.String[] properties, int begin, int end)
125         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
126         com.liferay.portal.kernel.json.JSONArrayWrapper returnValue = TagsEntryServiceUtil.searchAutocomplete(companyId,
127                 name, properties, begin, end);
128 
129         return (JSONArray)returnValue.getValue();
130     }
131 
132     public static int searchCount(long companyId, java.lang.String name,
133         java.lang.String[] properties)
134         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
135         int returnValue = TagsEntryServiceUtil.searchCount(companyId, name,
136                 properties);
137 
138         return returnValue;
139     }
140 
141     public static JSONObject updateEntry(long entryId, java.lang.String name)
142         throws com.liferay.portal.SystemException, 
143             com.liferay.portal.PortalException, java.rmi.RemoteException {
144         com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.updateEntry(entryId,
145                 name);
146 
147         return TagsEntryJSONSerializer.toJSONObject(returnValue);
148     }
149 
150     public static JSONObject updateEntry(long entryId, java.lang.String name,
151         java.lang.String[] properties)
152         throws com.liferay.portal.SystemException, 
153             com.liferay.portal.PortalException, java.rmi.RemoteException {
154         com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.updateEntry(entryId,
155                 name, properties);
156 
157         return TagsEntryJSONSerializer.toJSONObject(returnValue);
158     }
159 }