Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright
|
Modifier and Type | Method and Description |
---|---|
void |
cancelCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon)
Cancels a coupon after it has been used.
|
void |
deleteCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon)
Deletes a coupon.
|
void |
deselectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey)
Removes a coupon from an order so that it will not be applied to an order.
|
void |
deselectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey,
java.util.Date date)
Deprecated.
Use deselectCouponForUseInOrder(CouponKey ckey)
|
com.ibm.commerce.marketing.promotion.coupon.Coupon |
issueCoupon(CustomerKey user,
Promotion promotion,
java.lang.String code)
Issues a coupon for a registered user.
|
com.ibm.commerce.marketing.promotion.coupon.Coupon |
issueCoupon(CustomerKey user,
Promotion promotion,
java.lang.String code,
java.util.Date time)
Deprecated.
Use issueCoupon(CustomerKey user,Promotion promotion,String code)
|
com.ibm.commerce.marketing.promotion.coupon.Coupon[] |
listCouponsFor(CustomerKey customerKey,
int state)
Lists coupons in a state for a user.
|
com.ibm.commerce.marketing.promotion.coupon.Coupon[] |
listCouponsFor(CustomerKey customerKey,
int state,
java.util.Date date)
Deprecated.
Use listCouponsFor(CustomerKey customerKey, int state)
|
com.ibm.commerce.marketing.promotion.coupon.Coupon[] |
listCouponsInUseForOrder(OrderKey okey)
Lists coupons in use for an order.
|
com.ibm.commerce.marketing.promotion.coupon.Coupon[] |
listCouponsInUseForOrder(OrderKey okey,
java.util.Date date)
Deprecated.
Use listCouponsInUseForOrder(OrderKey okey)
|
void |
restoreCancelledCouponsInOrder(OrderKey okey)
This method restores all cancelled coupons in a specified order.
|
void |
restoreUnusedCouponsInOrder(OrderKey okey)
Restores all unused coupons in an order.
|
void |
restoreUnusedCouponsInOrder(OrderKey okey,
java.util.Date date)
Deprecated.
Use restoreUnusedCouponsInOrder(OrderKey okey)
|
void |
selectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey,
CustomerKey ukey,
OrderKey okey)
Selects a coupon and adds it to an order so that the coupon will be used with the order.
|
void |
selectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey,
CustomerKey ukey,
OrderKey okey,
java.util.Date date)
Deprecated.
Use selectCouponForUseInOrder(CouponKey ckey,CustomerKey ukey,OrderKey okey)
|
com.ibm.commerce.marketing.promotion.coupon.Coupon |
transferCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon,
CustomerKey to)
Transfers a coupon from the original owner to another owner.
|
com.ibm.commerce.marketing.promotion.coupon.Coupon |
transferCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon,
CustomerKey to,
java.util.Date date)
Deprecated.
Use transferCoupon(Coupon coupon, CustomerKey to)
|
PromotionErrorReport |
validateCoupon(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey,
CustomerKey ukey)
Validates a coupon.
|
PromotionErrorReport |
validateCoupon(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey,
CustomerKey ukey,
java.util.Date date)
Deprecated.
Use validateCoupon(CouponKey ckey,CustomerKey ukey)
|
static final java.lang.String COPYRIGHT
com.ibm.commerce.marketing.promotion.coupon.Coupon issueCoupon(CustomerKey user, Promotion promotion, java.lang.String code) throws PromotionApplicationException
user
- the recipient, a registered user.promotion
- the promotion for which a coupon is issued.code
- optional code for this coupon, null if not provided.PromotionApplicationException
- is thrown when the system encounters an error.com.ibm.commerce.marketing.promotion.coupon.Coupon issueCoupon(CustomerKey user, Promotion promotion, java.lang.String code, java.util.Date time) throws PromotionApplicationException
user
- the recipient, a registered userpromotion
- the promotion for which a coupon is being issued.code
- optional code for this coupon, null if not provided.time
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- is thrown when the system encounters an errorcom.ibm.commerce.marketing.promotion.coupon.Coupon transferCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon, CustomerKey to, java.util.Date date) throws PromotionApplicationException
to
coupon
- the coupon to be transferredto
- the recipient of the transfer, a registered userdate
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- is thrown when the system encounters an errorcom.ibm.commerce.marketing.promotion.coupon.Coupon transferCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon, CustomerKey to) throws PromotionApplicationException
coupon
- the coupon to be transferred.to
- is the recipient of coupon to be transferred, must be a registered user.PromotionApplicationException
- is thrown when the system encounters an error.void cancelCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon) throws PromotionApplicationException
coupon
- the coupon to be cancelled.PromotionApplicationException
- is thrown when the system encounters an error.void deleteCoupon(com.ibm.commerce.marketing.promotion.coupon.Coupon coupon) throws PromotionApplicationException
coupon
- to be deleted.PromotionApplicationException
- is thrown when the system encounters an error.com.ibm.commerce.marketing.promotion.coupon.Coupon[] listCouponsFor(CustomerKey customerKey, int state)
customerKey
- the user, a registered user.state
- the state of the coupon.com.ibm.commerce.marketing.promotion.coupon.Coupon[] listCouponsFor(CustomerKey customerKey, int state, java.util.Date date)
customerKey
- the user, a registered user.state
- the state of coupon.date
- is the current or preview time to check if the coupon is valid or not.com.ibm.commerce.marketing.promotion.coupon.Coupon[] listCouponsInUseForOrder(OrderKey okey)
okey
- is the key of the order.com.ibm.commerce.marketing.promotion.coupon.Coupon[] listCouponsInUseForOrder(OrderKey okey, java.util.Date date)
okey
- key of the order.date
- Current or Preview time to check if the coupon is valid or not.void selectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey, CustomerKey ukey, OrderKey okey) throws PromotionApplicationException
ckey
- key of the couponukey
- key of the user.okey
- key of the order.PromotionApplicationException
- when the coupon is not valid.void selectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey, CustomerKey ukey, OrderKey okey, java.util.Date date) throws PromotionApplicationException
ckey
- key of the couponukey
- key of the user.okey
- key of the order.date
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- when the coupon is not validvoid deselectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey) throws PromotionApplicationException
ckey
- the key of the coupon.PromotionApplicationException
- is thrown when the system encounters an error.void deselectCouponForUseInOrder(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey, java.util.Date date) throws PromotionApplicationException
ckey
- the key of the coupondate
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- is thrown when the system encounters an errorvoid restoreUnusedCouponsInOrder(OrderKey okey) throws PromotionApplicationException
okey
- key of the order.PromotionApplicationException
- is thrown when the system encounters an error.void restoreUnusedCouponsInOrder(OrderKey okey, java.util.Date date) throws PromotionApplicationException
okey
- key of the orderdate
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- is thrown when the system encounters an errorvoid restoreCancelledCouponsInOrder(OrderKey okey) throws PromotionApplicationException
okey
- key of the orderPromotionApplicationException
- is thrown when the system encounters an errorPromotionErrorReport validateCoupon(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey, CustomerKey ukey) throws PromotionApplicationException
ckey
- is the key for the coupon.ukey
- the key of the user who entered this coupon.PromotionApplicationException
- is thrown when the system encounters an error.PromotionErrorReport validateCoupon(com.ibm.commerce.marketing.promotion.coupon.CouponKey ckey, CustomerKey ukey, java.util.Date date) throws PromotionApplicationException
ckey
- is the key for the coupon.ukey
- the user who entered this coupondate
- Current or Preview time to check if the coupon is valid or not.PromotionApplicationException
- is thrown when the system encounters an error