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