| ShoppingCouponServiceJSON.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.shopping.service.http;
24
25 import com.liferay.portlet.shopping.service.ShoppingCouponServiceUtil;
26
27 import org.json.JSONArray;
28 import org.json.JSONObject;
29
30 /**
31 * <a href="ShoppingCouponServiceJSON.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.shopping.service.ShoppingCouponServiceUtil</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.shopping.model.ShoppingCoupon</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.shopping.service.http.ShoppingCouponJSONSerializer</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.shopping.service.ShoppingCouponServiceUtil
71 * @see com.liferay.portlet.shopping.service.http.ShoppingCouponJSONSerializer
72 *
73 */
74 public class ShoppingCouponServiceJSON {
75 public static JSONObject addCoupon(long plid, java.lang.String code,
76 boolean autoCode, java.lang.String name, java.lang.String description,
77 int startDateMonth, int startDateDay, int startDateYear,
78 int startDateHour, int startDateMinute, int endDateMonth,
79 int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
80 boolean neverExpire, boolean active, java.lang.String limitCategories,
81 java.lang.String limitSkus, double minOrder, double discount,
82 java.lang.String discountType)
83 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
84 com.liferay.portal.PortalException {
85 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.addCoupon(plid,
86 code, autoCode, name, description, startDateMonth,
87 startDateDay, startDateYear, startDateHour, startDateMinute,
88 endDateMonth, endDateDay, endDateYear, endDateHour,
89 endDateMinute, neverExpire, active, limitCategories, limitSkus,
90 minOrder, discount, discountType);
91
92 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
93 }
94
95 public static void deleteCoupon(long plid, long couponId)
96 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
97 com.liferay.portal.PortalException {
98 ShoppingCouponServiceUtil.deleteCoupon(plid, couponId);
99 }
100
101 public static JSONObject getCoupon(long plid, long couponId)
102 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
103 com.liferay.portal.PortalException {
104 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.getCoupon(plid,
105 couponId);
106
107 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
108 }
109
110 public static JSONArray search(long plid, long companyId,
111 java.lang.String code, boolean active, java.lang.String discountType,
112 boolean andOperator, int begin, int end)
113 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
114 com.liferay.portal.PortalException {
115 java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> returnValue =
116 ShoppingCouponServiceUtil.search(plid, companyId, code, active,
117 discountType, andOperator, begin, end);
118
119 return ShoppingCouponJSONSerializer.toJSONArray(returnValue);
120 }
121
122 public static JSONObject updateCoupon(long plid, long couponId,
123 java.lang.String name, java.lang.String description,
124 int startDateMonth, int startDateDay, int startDateYear,
125 int startDateHour, int startDateMinute, int endDateMonth,
126 int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
127 boolean neverExpire, boolean active, java.lang.String limitCategories,
128 java.lang.String limitSkus, double minOrder, double discount,
129 java.lang.String discountType)
130 throws java.rmi.RemoteException, com.liferay.portal.SystemException,
131 com.liferay.portal.PortalException {
132 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.updateCoupon(plid,
133 couponId, name, description, startDateMonth, startDateDay,
134 startDateYear, startDateHour, startDateMinute, endDateMonth,
135 endDateDay, endDateYear, endDateHour, endDateMinute,
136 neverExpire, active, limitCategories, limitSkus, minOrder,
137 discount, discountType);
138
139 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
140 }
141 }