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.messageboards.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.messageboards.service.MBMessageServiceUtil;
29  
30  /**
31   * <a href="MBMessageServiceJSON.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.messageboards.service.MBMessageServiceUtil</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.messageboards.model.MBMessage</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.messageboards.service.http.MBMessageJSONSerializer</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.messageboards.service.MBMessageServiceUtil
73   * @see com.liferay.portlet.messageboards.service.http.MBMessageJSONSerializer
74   *
75   */
76  public class MBMessageServiceJSON {
77      public static JSONObject addDiscussionMessage(java.lang.String className,
78          long classPK, long threadId, long parentMessageId,
79          java.lang.String subject, java.lang.String body,
80          com.liferay.portal.service.ServiceContext serviceContext)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException {
83          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addDiscussionMessage(className,
84                  classPK, threadId, parentMessageId, subject, body,
85                  serviceContext);
86  
87          return MBMessageJSONSerializer.toJSONObject(returnValue);
88      }
89  
90      public static JSONObject addMessage(long categoryId,
91          java.lang.String subject, java.lang.String body,
92          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
93          boolean anonymous, double priority,
94          com.liferay.portal.service.ServiceContext serviceContext)
95          throws com.liferay.portal.PortalException,
96              com.liferay.portal.SystemException {
97          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
98                  subject, body, files, anonymous, priority, serviceContext);
99  
100         return MBMessageJSONSerializer.toJSONObject(returnValue);
101     }
102 
103     public static JSONObject addMessage(long categoryId, long threadId,
104         long parentMessageId, java.lang.String subject, java.lang.String body,
105         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
106         boolean anonymous, double priority,
107         com.liferay.portal.service.ServiceContext serviceContext)
108         throws com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException {
110         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
111                 threadId, parentMessageId, subject, body, files, anonymous,
112                 priority, serviceContext);
113 
114         return MBMessageJSONSerializer.toJSONObject(returnValue);
115     }
116 
117     public static void deleteDiscussionMessage(long groupId,
118         java.lang.String className, long classPK, long messageId)
119         throws com.liferay.portal.PortalException,
120             com.liferay.portal.SystemException {
121         MBMessageServiceUtil.deleteDiscussionMessage(groupId, className,
122             classPK, messageId);
123     }
124 
125     public static void deleteMessage(long messageId)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException {
128         MBMessageServiceUtil.deleteMessage(messageId);
129     }
130 
131     public static JSONArray getCategoryMessages(long categoryId, int start,
132         int end)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException {
135         java.util.List<com.liferay.portlet.messageboards.model.MBMessage> returnValue =
136             MBMessageServiceUtil.getCategoryMessages(categoryId, start, end);
137 
138         return MBMessageJSONSerializer.toJSONArray(returnValue);
139     }
140 
141     public static int getCategoryMessagesCount(long categoryId)
142         throws com.liferay.portal.SystemException {
143         int returnValue = MBMessageServiceUtil.getCategoryMessagesCount(categoryId);
144 
145         return returnValue;
146     }
147 
148     public static JSONObject getMessage(long messageId)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException {
151         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.getMessage(messageId);
152 
153         return MBMessageJSONSerializer.toJSONObject(returnValue);
154     }
155 
156     public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(
157         long messageId)
158         throws com.liferay.portal.PortalException,
159             com.liferay.portal.SystemException {
160         com.liferay.portlet.messageboards.model.MBMessageDisplay returnValue = MBMessageServiceUtil.getMessageDisplay(messageId);
161 
162         return returnValue;
163     }
164 
165     public static void subscribeMessage(long messageId)
166         throws com.liferay.portal.PortalException,
167             com.liferay.portal.SystemException {
168         MBMessageServiceUtil.subscribeMessage(messageId);
169     }
170 
171     public static void unsubscribeMessage(long messageId)
172         throws com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException {
174         MBMessageServiceUtil.unsubscribeMessage(messageId);
175     }
176 
177     public static JSONObject updateDiscussionMessage(
178         java.lang.String className, long classPK, long messageId,
179         java.lang.String subject, java.lang.String body,
180         com.liferay.portal.service.ServiceContext serviceContext)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException {
183         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateDiscussionMessage(className,
184                 classPK, messageId, subject, body, serviceContext);
185 
186         return MBMessageJSONSerializer.toJSONObject(returnValue);
187     }
188 
189     public static JSONObject updateMessage(long messageId,
190         java.lang.String subject, java.lang.String body,
191         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
192         java.util.List<String> existingFiles, double priority,
193         com.liferay.portal.service.ServiceContext serviceContext)
194         throws com.liferay.portal.PortalException,
195             com.liferay.portal.SystemException {
196         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateMessage(messageId,
197                 subject, body, files, existingFiles, priority, serviceContext);
198 
199         return MBMessageJSONSerializer.toJSONObject(returnValue);
200     }
201 }