com.ibm.commerce.orderitems.commands
Interface AddOrderItemComponentsCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
AddOrderItemComponentsCmdImpl

public interface AddOrderItemComponentsCmd
extends TaskCommand

Creates the componets that are associated with a composite order item. It derives the component list in one of two ways

Only one of the ConfigurationId and the Components are required. Quantity is only required if a component list is provided If the componets are explicitly set, then they are used, otherwise, they are dervied from the ConfigurationId.

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String ERRTASK_NAME
          The error task name.
static java.lang.String NAME
          The name of the Command Interface class.
 
Method Summary
 java.util.Vector getOutComponentList()
          Gets the output list of components that were created or updated.
 void setComponents(java.lang.Long[] anCatentry)
          Set a list of Catalog Entries (components) that will be added to the OrderItem.
 void setConfigurationId(java.lang.String astrConfigurationId)
          Sets the configuration id that is used to retrieve the components
 void setCurrency(java.lang.String astrCurrency)
          (Optional)Sets the currency for the prices of the components.
 void setOrderItemId(java.lang.Long anOrderItemId)
          (Optional) Set an OrderItem that the componets will be added to.
 void setPrices(java.math.BigDecimal[] anPrice)
          (Optional) Sets a list of prices for the components that will be added to the OrderItem.
 void setQuantity(java.lang.Double[] anQuantity)           Set a list of quantities of each Catalog Entry (component) that will be added to the OrderItem.
 

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

NAME

public static final java.lang.String NAME
The name of the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values

ERRTASK_NAME

public static final java.lang.String ERRTASK_NAME
The error task name.
See Also:
Constant Field Values
Method Detail

getOutComponentList

public java.util.Vector getOutComponentList()
Gets the output list of components that were created or updated.
Returns:
Vector a list of components.

setComponents

public void setComponents(java.lang.Long[] anCatentry)
Set a list of Catalog Entries (components) that will be added to the OrderItem.
Parameters:
anCatentry - an array of input catalog entry id.

setConfigurationId

public void setConfigurationId(java.lang.String astrConfigurationId)
Sets the configuration id that is used to retrieve the components
Parameters:
astrConfigurationId - the input configuration id.

setCurrency

public void setCurrency(java.lang.String astrCurrency)
(Optional)Sets the currency for the prices of the components.
Parameters:
astrCurrency - the input currency

setOrderItemId

public void setOrderItemId(java.lang.Long anOrderItemId)
(Optional) Set an OrderItem that the componets will be added to.
Parameters:
anOrderItemId - the input order item id.

setPrices

public void setPrices(java.math.BigDecimal[] anPrice)
(Optional) Sets a list of prices for the components that will be added to the OrderItem.
Parameters:
anPrice - an array of input price.

setQuantity

public void setQuantity(java.lang.Double[] anQuantity)
Set a list of quantities of each Catalog Entry (component) that will be added to the OrderItem.
Parameters:
anQuantity - an array of input quantity.