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