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.wiki.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.wiki.service.WikiPageServiceUtil;
29  
30  /**
31   * <a href="WikiPageServiceJSON.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.wiki.service.WikiPageServiceUtil</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.wiki.model.WikiPage</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.wiki.service.http.WikiPageJSONSerializer</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.wiki.service.WikiPageServiceUtil
73   * @see com.liferay.portlet.wiki.service.http.WikiPageJSONSerializer
74   *
75   */
76  public class WikiPageServiceJSON {
77      public static JSONObject addPage(long nodeId, java.lang.String title,
78          java.lang.String content, java.lang.String summary, boolean minorEdit,
79          com.liferay.portal.service.ServiceContext serviceContext)
80          throws com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException {
82          com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.addPage(nodeId,
83                  title, content, summary, minorEdit, serviceContext);
84  
85          return WikiPageJSONSerializer.toJSONObject(returnValue);
86      }
87  
88      public static void addPageAttachments(long nodeId, java.lang.String title,
89          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
90          throws com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException {
92          WikiPageServiceUtil.addPageAttachments(nodeId, title, files);
93      }
94  
95      public static void changeParent(long nodeId, java.lang.String title,
96          java.lang.String newParentTitle,
97          com.liferay.portal.service.ServiceContext serviceContext)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException {
100         WikiPageServiceUtil.changeParent(nodeId, title, newParentTitle,
101             serviceContext);
102     }
103 
104     public static void deletePage(long nodeId, java.lang.String title)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException {
107         WikiPageServiceUtil.deletePage(nodeId, title);
108     }
109 
110     public static void deletePageAttachment(long nodeId,
111         java.lang.String title, java.lang.String fileName)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException {
114         WikiPageServiceUtil.deletePageAttachment(nodeId, title, fileName);
115     }
116 
117     public static JSONArray getNodePages(long nodeId, int max)
118         throws com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException {
120         java.util.List<com.liferay.portlet.wiki.model.WikiPage> returnValue = WikiPageServiceUtil.getNodePages(nodeId,
121                 max);
122 
123         return WikiPageJSONSerializer.toJSONArray(returnValue);
124     }
125 
126     public static java.lang.String getNodePagesRSS(long nodeId, int max,
127         java.lang.String type, double version, java.lang.String displayStyle,
128         java.lang.String feedURL, java.lang.String entryURL)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException {
131         java.lang.String returnValue = WikiPageServiceUtil.getNodePagesRSS(nodeId,
132                 max, type, version, displayStyle, feedURL, entryURL);
133 
134         return returnValue;
135     }
136 
137     public static JSONObject getPage(long nodeId, java.lang.String title)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException {
140         com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.getPage(nodeId,
141                 title);
142 
143         return WikiPageJSONSerializer.toJSONObject(returnValue);
144     }
145 
146     public static JSONObject getPage(long nodeId, java.lang.String title,
147         double version)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException {
150         com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.getPage(nodeId,
151                 title, version);
152 
153         return WikiPageJSONSerializer.toJSONObject(returnValue);
154     }
155 
156     public static java.lang.String getPagesRSS(long companyId, long nodeId,
157         java.lang.String title, int max, java.lang.String type, double version,
158         java.lang.String displayStyle, java.lang.String feedURL,
159         java.lang.String entryURL, String locale)
160         throws com.liferay.portal.PortalException,
161             com.liferay.portal.SystemException {
162         java.lang.String returnValue = WikiPageServiceUtil.getPagesRSS(companyId,
163                 nodeId, title, max, type, version, displayStyle, feedURL,
164                 entryURL, new java.util.Locale(locale));
165 
166         return returnValue;
167     }
168 
169     public static void movePage(long nodeId, java.lang.String title,
170         java.lang.String newTitle,
171         com.liferay.portal.service.ServiceContext serviceContext)
172         throws com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException {
174         WikiPageServiceUtil.movePage(nodeId, title, newTitle, serviceContext);
175     }
176 
177     public static JSONObject revertPage(long nodeId, java.lang.String title,
178         double version, com.liferay.portal.service.ServiceContext serviceContext)
179         throws com.liferay.portal.PortalException,
180             com.liferay.portal.SystemException {
181         com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.revertPage(nodeId,
182                 title, version, serviceContext);
183 
184         return WikiPageJSONSerializer.toJSONObject(returnValue);
185     }
186 
187     public static void subscribePage(long nodeId, java.lang.String title)
188         throws com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException {
190         WikiPageServiceUtil.subscribePage(nodeId, title);
191     }
192 
193     public static void unsubscribePage(long nodeId, java.lang.String title)
194         throws com.liferay.portal.PortalException,
195             com.liferay.portal.SystemException {
196         WikiPageServiceUtil.unsubscribePage(nodeId, title);
197     }
198 
199     public static JSONObject updatePage(long nodeId, java.lang.String title,
200         double version, java.lang.String content, java.lang.String summary,
201         boolean minorEdit, java.lang.String format,
202         java.lang.String parentTitle, java.lang.String redirectTitle,
203         com.liferay.portal.service.ServiceContext serviceContext)
204         throws com.liferay.portal.PortalException,
205             com.liferay.portal.SystemException {
206         com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.updatePage(nodeId,
207                 title, version, content, summary, minorEdit, format,
208                 parentTitle, redirectTitle, serviceContext);
209 
210         return WikiPageJSONSerializer.toJSONObject(returnValue);
211     }
212 }