com.ibm.commerce.couponredemption.commands
Interface UseCouponIdTaskCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
UseCouponIdTaskCmdImpl

public interface UseCouponIdTaskCmd
extends TaskCommand

This command is invoked when the shopper specifies a set of eCoupon codes explicitly while checking out.

The input to this command is :

If the given set of BCIDs aren't valid for this shopper from the CPWALLET, then an error page is send to the user. If the above condition is true then, the following steps are performed. The CheckValidityCmd command is called to find the eCoupons that are not expired and for not expired eCoupons, CheckApplicabilityCmd command is called to find out which eCoupons are applicable for this order. For applicable coupons, CalculateDiscountAmtCmd command is called to calculate the discount amount and CouponDSSTaskCmd command is called to check for any conflict.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String Name
           
 
Method Summary
 java.util.Hashtable getConflicts()
          Return the conflicts.
 java.lang.Integer getErrorCode()
          Returns the error code.
 java.util.Vector getInvalidCoupons()
          Returns the invalid coupons.
 int getNumCoupons()
          Returns the number of coupons.
 boolean isValidSelection()
          Returns true if the selection was valid.
 void setCouponIds(java.lang.Long[] param)
          Sets teh couponIds.
 void setOrderId(java.lang.Long param)
          Set the orderId.
 void setRequestProperties(TypedProperty param)
          Set the request properties.
 void setShopperId(java.lang.Long paramShopperId)
          Sets the shopperId.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

Name

public static final java.lang.String Name
Method Detail

getConflicts

public java.util.Hashtable getConflicts()
Return the conflicts.
Returns:
java.util.Hashtable

getErrorCode

public java.lang.Integer getErrorCode()
Returns the error code.
Returns:
java.lang.Integer

getInvalidCoupons

public java.util.Vector getInvalidCoupons()
Returns the invalid coupons.
Returns:
java.util.Vector

getNumCoupons

public int getNumCoupons()
Returns the number of coupons.
Returns:
int

isValidSelection

public boolean isValidSelection()
Returns true if the selection was valid.
Returns:
boolean

setCouponIds

public void setCouponIds(java.lang.Long[] param)
Sets teh couponIds.
Parameters:
param - java.lang.Long[]

setOrderId

public void setOrderId(java.lang.Long param)
Set the orderId.
Parameters:
param - java.lang.Long

setRequestProperties

public void setRequestProperties(TypedProperty param)
Set the request properties.
Parameters:
param - com.ibm.commerce.datatype.TypedProperty

setShopperId

public void setShopperId(java.lang.Long paramShopperId)
Sets the shopperId.
Parameters:
paramShopperId - java.lang.Long