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.TagsAssetServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="TagsAssetServiceJSON.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.TagsAssetServiceUtil</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.TagsAsset</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.TagsAssetJSONSerializer</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.TagsAssetServiceUtil
71   * @see com.liferay.portlet.tags.service.http.TagsAssetJSONSerializer
72   *
73   */
74  public class TagsAssetServiceJSON {
75      public static void deleteAsset(long assetId)
76          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
77              com.liferay.portal.PortalException {
78          TagsAssetServiceUtil.deleteAsset(assetId);
79      }
80  
81      public static JSONObject getAsset(long assetId)
82          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
83              com.liferay.portal.PortalException {
84          com.liferay.portlet.tags.model.TagsAsset returnValue = TagsAssetServiceUtil.getAsset(assetId);
85  
86          return TagsAssetJSONSerializer.toJSONObject(returnValue);
87      }
88  
89      public static java.lang.String getAssetsRSS(long groupId,
90          long[] classNameIds, long[] entryIds, long[] notEntryIds,
91          boolean andOperator, java.lang.String orderByCol1,
92          java.lang.String orderByCol2, java.lang.String orderByType1,
93          java.lang.String orderByType2, boolean excludeZeroViewCount,
94          java.util.Date publishDate, java.util.Date expirationDate, int max,
95          java.lang.String type, double version, java.lang.String displayStyle,
96          java.lang.String feedURL, java.lang.String entryURL)
97          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
98              com.liferay.portal.PortalException {
99          java.lang.String returnValue = TagsAssetServiceUtil.getAssetsRSS(groupId,
100                 classNameIds, entryIds, notEntryIds, andOperator, orderByCol1,
101                 orderByCol2, orderByType1, orderByType2, excludeZeroViewCount,
102                 publishDate, expirationDate, max, type, version, displayStyle,
103                 feedURL, entryURL);
104 
105         return returnValue;
106     }
107 
108     public static com.liferay.portlet.tags.model.TagsAssetType[] getAssetTypes(
109         java.lang.String languageId) throws java.rmi.RemoteException {
110         com.liferay.portlet.tags.model.TagsAssetType[] returnValue = TagsAssetServiceUtil.getAssetTypes(languageId);
111 
112         return returnValue;
113     }
114 
115     public static com.liferay.portlet.tags.model.TagsAssetDisplay[] getCompanyAssetDisplays(
116         long companyId, int begin, int end, java.lang.String languageId)
117         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
118             com.liferay.portal.PortalException {
119         com.liferay.portlet.tags.model.TagsAssetDisplay[] returnValue = TagsAssetServiceUtil.getCompanyAssetDisplays(companyId,
120                 begin, end, languageId);
121 
122         return returnValue;
123     }
124 
125     public static JSONArray getCompanyAssets(long companyId, int begin, int end)
126         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
127         java.util.List<com.liferay.portlet.tags.model.TagsAsset> returnValue = TagsAssetServiceUtil.getCompanyAssets(companyId,
128                 begin, end);
129 
130         return TagsAssetJSONSerializer.toJSONArray(returnValue);
131     }
132 
133     public static int getCompanyAssetsCount(long companyId)
134         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
135         int returnValue = TagsAssetServiceUtil.getCompanyAssetsCount(companyId);
136 
137         return returnValue;
138     }
139 
140     public static java.lang.String getCompanyAssetsRSS(long companyId, int max,
141         java.lang.String type, double version, java.lang.String displayStyle,
142         java.lang.String feedURL, java.lang.String entryURL)
143         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
144             com.liferay.portal.PortalException {
145         java.lang.String returnValue = TagsAssetServiceUtil.getCompanyAssetsRSS(companyId,
146                 max, type, version, displayStyle, feedURL, entryURL);
147 
148         return returnValue;
149     }
150 
151     public static JSONObject incrementViewCounter(java.lang.String className,
152         long classPK)
153         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
154             com.liferay.portal.PortalException {
155         com.liferay.portlet.tags.model.TagsAsset returnValue = TagsAssetServiceUtil.incrementViewCounter(className,
156                 classPK);
157 
158         return TagsAssetJSONSerializer.toJSONObject(returnValue);
159     }
160 
161     public static com.liferay.portlet.tags.model.TagsAssetDisplay[] searchAssetDisplays(
162         long companyId, java.lang.String portletId, java.lang.String keywords,
163         java.lang.String languageId, int begin, int end)
164         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
165             com.liferay.portal.PortalException {
166         com.liferay.portlet.tags.model.TagsAssetDisplay[] returnValue = TagsAssetServiceUtil.searchAssetDisplays(companyId,
167                 portletId, keywords, languageId, begin, end);
168 
169         return returnValue;
170     }
171 
172     public static int searchAssetDisplaysCount(long companyId,
173         java.lang.String portletId, java.lang.String keywords,
174         java.lang.String languageId)
175         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
176         int returnValue = TagsAssetServiceUtil.searchAssetDisplaysCount(companyId,
177                 portletId, keywords, languageId);
178 
179         return returnValue;
180     }
181 
182     public static JSONObject updateAsset(long groupId,
183         java.lang.String className, long classPK,
184         java.lang.String[] entryNames, java.util.Date startDate,
185         java.util.Date endDate, java.util.Date publishDate,
186         java.util.Date expirationDate, java.lang.String mimeType,
187         java.lang.String title, java.lang.String description,
188         java.lang.String summary, java.lang.String url, int height, int width,
189         java.lang.Integer priority)
190         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
191             com.liferay.portal.PortalException {
192         com.liferay.portlet.tags.model.TagsAsset returnValue = TagsAssetServiceUtil.updateAsset(groupId,
193                 className, classPK, entryNames, startDate, endDate,
194                 publishDate, expirationDate, mimeType, title, description,
195                 summary, url, height, width, priority);
196 
197         return TagsAssetJSONSerializer.toJSONObject(returnValue);
198     }
199 }