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