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