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.polls.service.http;
24  
25  import com.liferay.portlet.polls.service.PollsQuestionServiceUtil;
26  
27  import org.json.JSONObject;
28  
29  /**
30   * <a href="PollsQuestionServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be
34   * overwritten the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the
39   * <code>com.liferay.portlet.polls.service.PollsQuestionServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of
41   * the service utility. However, the signatures are different because it is
42   * difficult for JSON to support certain types.
43   * </p>
44   *
45   * <p>
46   * ServiceBuilder follows certain rules in translating the methods. For example,
47   * if the method in the service utility returns a <code>java.util.List</code>,
48   * that is translated to a <code>org.json.JSONArray</code>. If the method in the
49   * service utility returns a <code>com.liferay.portlet.polls.model.PollsQuestion</code>,
50   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
51   * cannot safely use are skipped. The logic for the translation is encapsulated
52   * in <code>com.liferay.portlet.polls.service.http.PollsQuestionJSONSerializer</code>.
53   * </p>
54   *
55   * <p>
56   * This allows you to call the the backend services directly from JavaScript.
57   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
58   * reference of how that portlet uses the generated JavaScript in
59   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
60   * services directly from JavaScript.
61   * </p>
62   *
63   * <p>
64   * The JSON utility is only generated for remote services.
65   * </p>
66   *
67   * @author Brian Wing Shun Chan
68   *
69   * @see com.liferay.portlet.polls.service.PollsQuestionServiceUtil
70   * @see com.liferay.portlet.polls.service.http.PollsQuestionJSONSerializer
71   *
72   */
73  public class PollsQuestionServiceJSON {
74      public static JSONObject addQuestion(long plid, java.lang.String title,
75          java.lang.String description, int expirationDateMonth,
76          int expirationDateDay, int expirationDateYear, int expirationDateHour,
77          int expirationDateMinute, boolean neverExpire, java.util.List choices,
78          boolean addCommunityPermissions, boolean addGuestPermissions)
79          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
80              com.liferay.portal.PortalException {
81          com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.addQuestion(plid,
82                  title, description, expirationDateMonth, expirationDateDay,
83                  expirationDateYear, expirationDateHour, expirationDateMinute,
84                  neverExpire, choices, addCommunityPermissions,
85                  addGuestPermissions);
86  
87          return PollsQuestionJSONSerializer.toJSONObject(returnValue);
88      }
89  
90      public static JSONObject addQuestion(long plid, java.lang.String title,
91          java.lang.String description, int expirationDateMonth,
92          int expirationDateDay, int expirationDateYear, int expirationDateHour,
93          int expirationDateMinute, boolean neverExpire, java.util.List choices,
94          java.lang.String[] communityPermissions,
95          java.lang.String[] guestPermissions)
96          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
97              com.liferay.portal.PortalException {
98          com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.addQuestion(plid,
99                  title, description, expirationDateMonth, expirationDateDay,
100                 expirationDateYear, expirationDateHour, expirationDateMinute,
101                 neverExpire, choices, communityPermissions, guestPermissions);
102 
103         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
104     }
105 
106     public static void deleteQuestion(long questionId)
107         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
108             com.liferay.portal.PortalException {
109         PollsQuestionServiceUtil.deleteQuestion(questionId);
110     }
111 
112     public static JSONObject getQuestion(long questionId)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
114             com.liferay.portal.PortalException {
115         com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.getQuestion(questionId);
116 
117         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
118     }
119 
120     public static JSONObject updateQuestion(long questionId,
121         java.lang.String title, java.lang.String description,
122         int expirationDateMonth, int expirationDateDay, int expirationDateYear,
123         int expirationDateHour, int expirationDateMinute, boolean neverExpire,
124         java.util.List choices)
125         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
126             com.liferay.portal.PortalException {
127         com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.updateQuestion(questionId,
128                 title, description, expirationDateMonth, expirationDateDay,
129                 expirationDateYear, expirationDateHour, expirationDateMinute,
130                 neverExpire, choices);
131 
132         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
133     }
134 }