| WikiPageServiceJSON.java |
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.wiki.service.http;
24
25 import com.liferay.portlet.wiki.service.WikiPageServiceUtil;
26
27 import org.json.JSONArray;
28 import org.json.JSONObject;
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 <code>org.json.JSONArray</code>. If the method in the
50 * service utility returns a <code>com.liferay.portlet.wiki.model.WikiPage</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.wiki.service.http.WikiPageJSONSerializer</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.wiki.service.WikiPageServiceUtil
71 * @see com.liferay.portlet.wiki.service.http.WikiPageJSONSerializer
72 *
73 */
74 public class WikiPageServiceJSON {
75 public static void addPageAttachments(long nodeId, java.lang.String title,
76 java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
77 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
78 com.liferay.portal.PortalException {
79 WikiPageServiceUtil.addPageAttachments(nodeId, title, files);
80 }
81
82 public static void deletePage(long nodeId, java.lang.String title)
83 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
84 com.liferay.portal.PortalException {
85 WikiPageServiceUtil.deletePage(nodeId, title);
86 }
87
88 public static void deletePageAttachment(long nodeId,
89 java.lang.String title, java.lang.String fileName)
90 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
91 com.liferay.portal.PortalException {
92 WikiPageServiceUtil.deletePageAttachment(nodeId, title, fileName);
93 }
94
95 public static JSONArray getNodePages(long nodeId, int max)
96 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
97 com.liferay.portal.PortalException {
98 java.util.List<com.liferay.portlet.wiki.model.WikiPage> returnValue = WikiPageServiceUtil.getNodePages(nodeId,
99 max);
100
101 return WikiPageJSONSerializer.toJSONArray(returnValue);
102 }
103
104 public static java.lang.String getNodePagesRSS(long nodeId, int max,
105 java.lang.String type, double version, java.lang.String displayStyle,
106 java.lang.String feedURL, java.lang.String entryURL)
107 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
108 com.liferay.portal.PortalException {
109 java.lang.String returnValue = WikiPageServiceUtil.getNodePagesRSS(nodeId,
110 max, type, version, displayStyle, feedURL, entryURL);
111
112 return returnValue;
113 }
114
115 public static JSONObject getPage(long nodeId, java.lang.String title)
116 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
117 com.liferay.portal.PortalException {
118 com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.getPage(nodeId,
119 title);
120
121 return WikiPageJSONSerializer.toJSONObject(returnValue);
122 }
123
124 public static JSONObject getPage(long nodeId, java.lang.String title,
125 double version)
126 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
127 com.liferay.portal.PortalException {
128 com.liferay.portlet.wiki.model.WikiPage returnValue = WikiPageServiceUtil.getPage(nodeId,
129 title, version);
130
131 return WikiPageJSONSerializer.toJSONObject(returnValue);
132 }
133
134 public static java.lang.String getPagesRSS(long companyId, long nodeId,
135 java.lang.String title, int max, java.lang.String type, double version,
136 java.lang.String displayStyle, java.lang.String feedURL,
137 java.lang.String entryURL, String locale)
138 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
139 com.liferay.portal.PortalException {
140 java.lang.String returnValue = WikiPageServiceUtil.getPagesRSS(companyId,
141 nodeId, title, max, type, version, displayStyle, feedURL,
142 entryURL, new java.util.Locale(locale));
143
144 return returnValue;
145 }
146
147 public static void subscribePage(long nodeId, java.lang.String title)
148 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
149 com.liferay.portal.PortalException {
150 WikiPageServiceUtil.subscribePage(nodeId, title);
151 }
152
153 public static void unsubscribePage(long nodeId, java.lang.String title)
154 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
155 com.liferay.portal.PortalException {
156 WikiPageServiceUtil.unsubscribePage(nodeId, title);
157 }
158 }