com.ibm.commerce.couponredemption.commands
Interface CouponDSSTaskCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
CouponDSSTaskCmdImpl

public interface CouponDSSTaskCmd
extends TaskCommand

This task command is called from the CouponDSSCmd when user selects a set of eCoupons to be used on a set of items in her order.

The input to this command are :

The IDs of eCoupons that were selected for use with this order.
The order under consideration.
Optional (multiple: 1 for each coupon): The IDs of the items selected to be used with this coupon.

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.template.commands.TaskCmdTemplate is not defined in the CMDREG table
static java.lang.String Name
          Name of the interface
 
Method Summary
 java.util.Hashtable getConflicts()
          Returns the conflict hashtable.
 int getNumCoupons()
          Returns the number of coupons.
 java.util.Vector getUnQualifiedCoupons()
          Gets the coupons that did not qualify because of insufficient order items to which it applies.
 boolean isValidSelection()
          Returns whether the selection is valid or not.
 void setCouponId(java.lang.Long[] couponId)
          sets the coupon IDs.
 void setItemsSelected(java.util.Hashtable newItemsSelected)
          Sets the items that were selected for the coupons to be applied on.
 void setOrderId(java.lang.Long orderId)           sets the order ID.
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.template.commands.TaskCmdTemplate is not defined in the CMDREG table
See Also:
Constant Field Values

Name

public static final java.lang.String Name
Name of the interface
See Also:
Constant Field Values
Method Detail

getConflicts

public java.util.Hashtable getConflicts()
Returns the conflict hashtable.
Returns:
the hashtable containing the conflict information.

getNumCoupons

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

isValidSelection

public boolean isValidSelection()
Returns whether the selection is valid or not.
Returns:
true if the selection was valid.

setCouponId

public void setCouponId(java.lang.Long[] couponId)
sets the coupon IDs.
Parameters:
couponId - the array of couponIds.

setOrderId

public void setOrderId(java.lang.Long orderId)
sets the order ID.
Parameters:
orderId - the order ID for which the coupons are to be applied.

getUnQualifiedCoupons

public java.util.Vector getUnQualifiedCoupons()
Gets the coupons that did not qualify because of insufficient order items to which it applies.
Returns:
the coupon that did not qualify.

setItemsSelected

public void setItemsSelected(java.util.Hashtable newItemsSelected)
Sets the items that were selected for the coupons to be applied on. The key of the hashtable is the couponId and the value is array of strings representing the order item IDs.
Parameters:
newItemsSelected - hashtable of items being used for coupons.