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