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.portal.kernel.json.JSONArray;
26  import com.liferay.portal.kernel.json.JSONObject;
27  
28  import com.liferay.portlet.tags.service.TagsEntryServiceUtil;
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
50   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
51   * service utility returns a <code>com.liferay.portlet.tags.model.TagsEntry</code>,
52   * that is translated to a
53   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
54   * cannot safely use are skipped. The logic for the translation is encapsulated
55   * in <code>com.liferay.portlet.tags.service.http.TagsEntryJSONSerializer</code>.
56   * </p>
57   *
58   * <p>
59   * This allows you to call the the backend services directly from JavaScript.
60   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
61   * reference of how that portlet uses the generated JavaScript in
62   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
63   * services directly from JavaScript.
64   * </p>
65   *
66   * <p>
67   * The JSON utility is only generated for remote services.
68   * </p>
69   *
70   * @author Brian Wing Shun Chan
71   *
72   * @see com.liferay.portlet.tags.service.TagsEntryServiceUtil
73   * @see com.liferay.portlet.tags.service.http.TagsEntryJSONSerializer
74   *
75   */
76  public class TagsEntryServiceJSON {
77      public static JSONObject addEntry(java.lang.String name)
78          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException {
80          com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.addEntry(name);
81  
82          return TagsEntryJSONSerializer.toJSONObject(returnValue);
83      }
84  
85      public static JSONObject addEntry(java.lang.String name,
86          java.lang.String[] properties)
87          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException {
89          com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.addEntry(name,
90                  properties);
91  
92          return TagsEntryJSONSerializer.toJSONObject(returnValue);
93      }
94  
95      public static void deleteEntry(long entryId)
96          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException {
98          TagsEntryServiceUtil.deleteEntry(entryId);
99      }
100 
101     public static JSONArray getEntries(java.lang.String className, long classPK)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
103         java.util.List<com.liferay.portlet.tags.model.TagsEntry> returnValue = TagsEntryServiceUtil.getEntries(className,
104                 classPK);
105 
106         return TagsEntryJSONSerializer.toJSONArray(returnValue);
107     }
108 
109     public static JSONArray getEntries(long groupId, long companyId,
110         long classNameId, java.lang.String name)
111         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
112         java.util.List<com.liferay.portlet.tags.model.TagsEntry> returnValue = TagsEntryServiceUtil.getEntries(groupId,
113                 companyId, classNameId, name);
114 
115         return TagsEntryJSONSerializer.toJSONArray(returnValue);
116     }
117 
118     public static void mergeEntries(long fromEntryId, long toEntryId)
119         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
120             com.liferay.portal.SystemException {
121         TagsEntryServiceUtil.mergeEntries(fromEntryId, toEntryId);
122     }
123 
124     public static JSONArray search(long companyId, java.lang.String name,
125         java.lang.String[] properties)
126         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
127         java.util.List<com.liferay.portlet.tags.model.TagsEntry> returnValue = TagsEntryServiceUtil.search(companyId,
128                 name, properties);
129 
130         return TagsEntryJSONSerializer.toJSONArray(returnValue);
131     }
132 
133     public static JSONArray search(long companyId, java.lang.String name,
134         java.lang.String[] properties, int start, int end)
135         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
136         java.util.List<com.liferay.portlet.tags.model.TagsEntry> returnValue = TagsEntryServiceUtil.search(companyId,
137                 name, properties, start, end);
138 
139         return TagsEntryJSONSerializer.toJSONArray(returnValue);
140     }
141 
142     public static com.liferay.portal.kernel.json.JSONArray searchAutocomplete(
143         long companyId, java.lang.String name, java.lang.String[] properties,
144         int start, int end)
145         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
146         com.liferay.portal.kernel.json.JSONArray returnValue = TagsEntryServiceUtil.searchAutocomplete(companyId,
147                 name, properties, start, end);
148 
149         return returnValue;
150     }
151 
152     public static int searchCount(long companyId, java.lang.String name,
153         java.lang.String[] properties)
154         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
155         int returnValue = TagsEntryServiceUtil.searchCount(companyId, name,
156                 properties);
157 
158         return returnValue;
159     }
160 
161     public static JSONObject updateEntry(long entryId, java.lang.String name)
162         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
163             com.liferay.portal.SystemException {
164         com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.updateEntry(entryId,
165                 name);
166 
167         return TagsEntryJSONSerializer.toJSONObject(returnValue);
168     }
169 
170     public static JSONObject updateEntry(long entryId, java.lang.String name,
171         java.lang.String[] properties)
172         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException {
174         com.liferay.portlet.tags.model.TagsEntry returnValue = TagsEntryServiceUtil.updateEntry(entryId,
175                 name, properties);
176 
177         return TagsEntryJSONSerializer.toJSONObject(returnValue);
178     }
179 }