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,
78          java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
79          boolean addCommunityPermissions, boolean addGuestPermissions)
80          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException {
82          com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.addQuestion(plid,
83                  title, description, expirationDateMonth, expirationDateDay,
84                  expirationDateYear, expirationDateHour, expirationDateMinute,
85                  neverExpire, choices, addCommunityPermissions,
86                  addGuestPermissions);
87  
88          return PollsQuestionJSONSerializer.toJSONObject(returnValue);
89      }
90  
91      public static JSONObject addQuestion(long plid, java.lang.String title,
92          java.lang.String description, int expirationDateMonth,
93          int expirationDateDay, int expirationDateYear, int expirationDateHour,
94          int expirationDateMinute, boolean neverExpire,
95          java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
96          java.lang.String[] communityPermissions,
97          java.lang.String[] guestPermissions)
98          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
99              com.liferay.portal.PortalException {
100         com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.addQuestion(plid,
101                 title, description, expirationDateMonth, expirationDateDay,
102                 expirationDateYear, expirationDateHour, expirationDateMinute,
103                 neverExpire, choices, communityPermissions, guestPermissions);
104 
105         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
106     }
107 
108     public static void deleteQuestion(long questionId)
109         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
110             com.liferay.portal.PortalException {
111         PollsQuestionServiceUtil.deleteQuestion(questionId);
112     }
113 
114     public static JSONObject getQuestion(long questionId)
115         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
116             com.liferay.portal.PortalException {
117         com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.getQuestion(questionId);
118 
119         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
120     }
121 
122     public static JSONObject updateQuestion(long questionId,
123         java.lang.String title, java.lang.String description,
124         int expirationDateMonth, int expirationDateDay, int expirationDateYear,
125         int expirationDateHour, int expirationDateMinute, boolean neverExpire,
126         java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices)
127         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
128             com.liferay.portal.PortalException {
129         com.liferay.portlet.polls.model.PollsQuestion returnValue = PollsQuestionServiceUtil.updateQuestion(questionId,
130                 title, description, expirationDateMonth, expirationDateDay,
131                 expirationDateYear, expirationDateHour, expirationDateMinute,
132                 neverExpire, choices);
133 
134         return PollsQuestionJSONSerializer.toJSONObject(returnValue);
135     }
136 }