com.ibm.commerce.couponredemption.commands
Interface CheckApplicabilityCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
CheckApplicabilityCmdImpl

public interface CheckApplicabilityCmd
extends TaskCommand

The purpose of this command is to check for applicability of the coupons on the shopping cart. The purchase condition are evaluated and the information is put in applicable variable which is used by the calling command.

The input to this command are:

The IDs of eCoupons to be checked for applicability.
The orderId for which eCoupons are being used.

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.Vector[] getApplicableItems()
          Returns an array of Vector where the nth element is the Vector of order items that satisfy the purchase conditions of the nth coupon.
  TypedProperty getResponseProperties()
          Gets the response properties.
 boolean[] getValidCoupons()
          Gets the array indicating whether the Coupons are applicable or not.
 void setApplicableItems(java.util.Vector[] newApplicableItems)
          Sets the applicable items.
 void setBcIds(java.lang.Long[] paramBcIds)
          Sets the eCoupon IDs.
 void setOrderId(java.lang.Long newOrderId)
          Sets the order IDs.
 void setProcessingContext( CommandContext newProcessingContext)
          Sets the processing context.
 void setRequestProperties( TypedProperty param)           Sets the request properties.
 

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

getApplicableItems

public java.util.Vector[] getApplicableItems()
Returns an array of Vector where the nth element is the Vector of order items that satisfy the purchase conditions of the nth coupon.

getResponseProperties

public TypedProperty getResponseProperties()
Gets the response properties.
Returns:
the response properties

getValidCoupons

public boolean[] getValidCoupons()
Gets the array indicating whether the Coupons are applicable or not.
Returns:
array whose nth element indicates if the nth coupon is applicable.

setBcIds

public void setBcIds(java.lang.Long[] paramBcIds)
Sets the eCoupon IDs.

setOrderId

public void setOrderId(java.lang.Long newOrderId)
Sets the order IDs.
Parameters:
newOrderId - the order on which the coupons are to be applied.

setProcessingContext

public void setProcessingContext(CommandContext newProcessingContext)
Sets the processing context.
Parameters:
newProcessingContext - the command context to be used in this task command.

setRequestProperties

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

setApplicableItems

public void setApplicableItems(java.util.Vector[] newApplicableItems)
Sets the applicable items.
Parameters:
newApplicableItems - the applicable items.