| BlogsEntryServiceJSON.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.blogs.service.http;
24
25 import com.liferay.portlet.blogs.service.BlogsEntryServiceUtil;
26
27 import org.json.JSONArray;
28 import org.json.JSONObject;
29
30 /**
31 * <a href="BlogsEntryServiceJSON.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.blogs.service.BlogsEntryServiceUtil</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.blogs.model.BlogsEntry</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.blogs.service.http.BlogsEntryJSONSerializer</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.blogs.service.BlogsEntryServiceUtil
71 * @see com.liferay.portlet.blogs.service.http.BlogsEntryJSONSerializer
72 *
73 */
74 public class BlogsEntryServiceJSON {
75 public static void deleteEntry(long entryId)
76 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
77 com.liferay.portal.PortalException {
78 BlogsEntryServiceUtil.deleteEntry(entryId);
79 }
80
81 public static JSONArray getCompanyEntries(long companyId, int max)
82 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
83 com.liferay.portal.PortalException {
84 java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> returnValue = BlogsEntryServiceUtil.getCompanyEntries(companyId,
85 max);
86
87 return BlogsEntryJSONSerializer.toJSONArray(returnValue);
88 }
89
90 public static java.lang.String getCompanyEntriesRSS(long companyId,
91 int max, java.lang.String type, double version,
92 java.lang.String displayStyle, java.lang.String feedURL,
93 java.lang.String entryURL)
94 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
95 com.liferay.portal.PortalException {
96 java.lang.String returnValue = BlogsEntryServiceUtil.getCompanyEntriesRSS(companyId,
97 max, type, version, displayStyle, feedURL, entryURL);
98
99 return returnValue;
100 }
101
102 public static JSONObject getEntry(long entryId)
103 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
104 com.liferay.portal.PortalException {
105 com.liferay.portlet.blogs.model.BlogsEntry returnValue = BlogsEntryServiceUtil.getEntry(entryId);
106
107 return BlogsEntryJSONSerializer.toJSONObject(returnValue);
108 }
109
110 public static JSONObject getEntry(long groupId, java.lang.String urlTitle)
111 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
112 com.liferay.portal.PortalException {
113 com.liferay.portlet.blogs.model.BlogsEntry returnValue = BlogsEntryServiceUtil.getEntry(groupId,
114 urlTitle);
115
116 return BlogsEntryJSONSerializer.toJSONObject(returnValue);
117 }
118
119 public static JSONArray getGroupEntries(long groupId, int max)
120 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
121 com.liferay.portal.PortalException {
122 java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> returnValue = BlogsEntryServiceUtil.getGroupEntries(groupId,
123 max);
124
125 return BlogsEntryJSONSerializer.toJSONArray(returnValue);
126 }
127
128 public static java.lang.String getGroupEntriesRSS(long groupId, int max,
129 java.lang.String type, double version, java.lang.String displayStyle,
130 java.lang.String feedURL, java.lang.String entryURL)
131 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
132 com.liferay.portal.PortalException {
133 java.lang.String returnValue = BlogsEntryServiceUtil.getGroupEntriesRSS(groupId,
134 max, type, version, displayStyle, feedURL, entryURL);
135
136 return returnValue;
137 }
138
139 public static JSONArray getOrganizationEntries(long organizationId, int max)
140 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
141 com.liferay.portal.PortalException {
142 java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> returnValue = BlogsEntryServiceUtil.getOrganizationEntries(organizationId,
143 max);
144
145 return BlogsEntryJSONSerializer.toJSONArray(returnValue);
146 }
147
148 public static java.lang.String getOrganizationEntriesRSS(
149 long organizationId, int max, java.lang.String type, double version,
150 java.lang.String displayStyle, java.lang.String feedURL,
151 java.lang.String entryURL)
152 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
153 com.liferay.portal.PortalException {
154 java.lang.String returnValue = BlogsEntryServiceUtil.getOrganizationEntriesRSS(organizationId,
155 max, type, version, displayStyle, feedURL, entryURL);
156
157 return returnValue;
158 }
159 }