| 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.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(long plid, java.lang.String code,
78 boolean autoCode, 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 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
86 com.liferay.portal.SystemException {
87 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.addCoupon(plid,
88 code, autoCode, name, description, startDateMonth,
89 startDateDay, startDateYear, startDateHour, startDateMinute,
90 endDateMonth, endDateDay, endDateYear, endDateHour,
91 endDateMinute, neverExpire, active, limitCategories, limitSkus,
92 minOrder, discount, discountType);
93
94 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
95 }
96
97 public static void deleteCoupon(long plid, long couponId)
98 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
99 com.liferay.portal.SystemException {
100 ShoppingCouponServiceUtil.deleteCoupon(plid, couponId);
101 }
102
103 public static JSONObject getCoupon(long plid, long couponId)
104 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
105 com.liferay.portal.SystemException {
106 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.getCoupon(plid,
107 couponId);
108
109 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
110 }
111
112 public static JSONArray search(long plid, long companyId,
113 java.lang.String code, boolean active, java.lang.String discountType,
114 boolean andOperator, int start, int end)
115 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
116 com.liferay.portal.SystemException {
117 java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> returnValue =
118 ShoppingCouponServiceUtil.search(plid, companyId, code, active,
119 discountType, andOperator, start, end);
120
121 return ShoppingCouponJSONSerializer.toJSONArray(returnValue);
122 }
123
124 public static JSONObject updateCoupon(long plid, long couponId,
125 java.lang.String name, java.lang.String description,
126 int startDateMonth, int startDateDay, int startDateYear,
127 int startDateHour, int startDateMinute, int endDateMonth,
128 int endDateDay, int endDateYear, int endDateHour, int endDateMinute,
129 boolean neverExpire, boolean active, java.lang.String limitCategories,
130 java.lang.String limitSkus, double minOrder, double discount,
131 java.lang.String discountType)
132 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
133 com.liferay.portal.SystemException {
134 com.liferay.portlet.shopping.model.ShoppingCoupon returnValue = ShoppingCouponServiceUtil.updateCoupon(plid,
135 couponId, name, description, startDateMonth, startDateDay,
136 startDateYear, startDateHour, startDateMinute, endDateMonth,
137 endDateDay, endDateYear, endDateHour, endDateMinute,
138 neverExpire, active, limitCategories, limitSkus, minOrder,
139 discount, discountType);
140
141 return ShoppingCouponJSONSerializer.toJSONObject(returnValue);
142 }
143 }