com.liferay.portlet.shopping.service.http
Class ShoppingCouponServiceJSON

java.lang.Object
  extended by com.liferay.portlet.shopping.service.http.ShoppingCouponServiceJSON

public class ShoppingCouponServiceJSON
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a JSON utility for the com.liferay.portlet.shopping.service.ShoppingCouponServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for JSON to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to a com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.shopping.model.ShoppingCoupon, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.shopping.service.http.ShoppingCouponJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
ShoppingCouponServiceUtil, ShoppingCouponJSONSerializer

Constructor Summary
ShoppingCouponServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addCoupon(java.lang.String code, boolean autoCode, java.lang.String name, java.lang.String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverExpire, boolean active, java.lang.String limitCategories, java.lang.String limitSkus, double minOrder, double discount, java.lang.String discountType, com.liferay.portal.service.ServiceContext serviceContext)
           
static void deleteCoupon(long groupId, long couponId)
           
static com.liferay.portal.kernel.json.JSONObject getCoupon(long groupId, long couponId)
           
static com.liferay.portal.kernel.json.JSONArray search(long groupId, long companyId, java.lang.String code, boolean active, java.lang.String discountType, boolean andOperator, int start, int end)
           
static com.liferay.portal.kernel.json.JSONObject updateCoupon(long couponId, java.lang.String name, java.lang.String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverExpire, boolean active, java.lang.String limitCategories, java.lang.String limitSkus, double minOrder, double discount, java.lang.String discountType, com.liferay.portal.service.ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShoppingCouponServiceJSON

public ShoppingCouponServiceJSON()
Method Detail

addCoupon

public static com.liferay.portal.kernel.json.JSONObject addCoupon(java.lang.String code,
                                                                  boolean autoCode,
                                                                  java.lang.String name,
                                                                  java.lang.String description,
                                                                  int startDateMonth,
                                                                  int startDateDay,
                                                                  int startDateYear,
                                                                  int startDateHour,
                                                                  int startDateMinute,
                                                                  int endDateMonth,
                                                                  int endDateDay,
                                                                  int endDateYear,
                                                                  int endDateHour,
                                                                  int endDateMinute,
                                                                  boolean neverExpire,
                                                                  boolean active,
                                                                  java.lang.String limitCategories,
                                                                  java.lang.String limitSkus,
                                                                  double minOrder,
                                                                  double discount,
                                                                  java.lang.String discountType,
                                                                  com.liferay.portal.service.ServiceContext serviceContext)
                                                           throws com.liferay.portal.PortalException,
                                                                  com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteCoupon

public static void deleteCoupon(long groupId,
                                long couponId)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCoupon

public static com.liferay.portal.kernel.json.JSONObject getCoupon(long groupId,
                                                                  long couponId)
                                                           throws com.liferay.portal.PortalException,
                                                                  com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

search

public static com.liferay.portal.kernel.json.JSONArray search(long groupId,
                                                              long companyId,
                                                              java.lang.String code,
                                                              boolean active,
                                                              java.lang.String discountType,
                                                              boolean andOperator,
                                                              int start,
                                                              int end)
                                                       throws com.liferay.portal.PortalException,
                                                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateCoupon

public static com.liferay.portal.kernel.json.JSONObject updateCoupon(long couponId,
                                                                     java.lang.String name,
                                                                     java.lang.String description,
                                                                     int startDateMonth,
                                                                     int startDateDay,
                                                                     int startDateYear,
                                                                     int startDateHour,
                                                                     int startDateMinute,
                                                                     int endDateMonth,
                                                                     int endDateDay,
                                                                     int endDateYear,
                                                                     int endDateHour,
                                                                     int endDateMinute,
                                                                     boolean neverExpire,
                                                                     boolean active,
                                                                     java.lang.String limitCategories,
                                                                     java.lang.String limitSkus,
                                                                     double minOrder,
                                                                     double discount,
                                                                     java.lang.String discountType,
                                                                     com.liferay.portal.service.ServiceContext serviceContext)
                                                              throws com.liferay.portal.PortalException,
                                                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException