com.ibm.commerce.couponredemption.commands
Interface UseCouponIdTaskCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
UseCouponIdTaskCmdImpl

public interface UseCouponIdTaskCmd
extends TaskCommand

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

The input to this command is :

The IDs of ecoupons that were selected for use with order.
The order under consideration.

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 this interface
 
Method Summary
 java.util.Hashtable getConflicts()
          Returns 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 the couponIds.
 void setKeepPrevious(boolean keepPrevious)
          Sets the keepPrevious.
 void setOrderId(java.lang.Long param)
          Sets the orderId.
 void setRequestProperties( TypedProperty param)
          Sets the request properties.
 void setShopperId(java.lang.Long paramShopperId)           Sets the shopperId.
 

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 this interface
See Also:
Constant Field Values
Method Detail

getConflicts

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

getErrorCode

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

getInvalidCoupons

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

getNumCoupons

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

isValidSelection

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

setCouponIds

public void setCouponIds(java.lang.Long[] param)
Sets the couponIds.
Parameters:
param - array of coupon IDs.

setOrderId

public void setOrderId(java.lang.Long param)
Sets the orderId.
Parameters:
param - the order ID.

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets the request properties.
Parameters:
param - the request properties.

setShopperId

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

setKeepPrevious

public void setKeepPrevious(boolean keepPrevious)
Sets the keepPrevious.
Parameters:
keepPrevious - The keepPrevious to set