com.ibm.commerce.orderitems.commands

Class AddOrderItemComponentsCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.orderitems.commands.AddOrderItemComponentsCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AddOrderItemComponentsCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class AddOrderItemComponentsCmdImpl
extends TaskCommandImpl
implements AddOrderItemComponentsCmd

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

• Uses a list of CatalogEntries that are passed in.
• Derives the list of components by finding all of the unassigned components through the given configuration id.

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

This command uses the following AccessBeans:

• OrderItemAccessBean
• CatalogEntryAccessBean
• CatalogEntryShippingAccessBean
• BaseItemAccessBean
• ItemSpecificationAccessBean
• OrderItemComponentAccessBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.orderitems.commands.AddOrderItemComponentsCmd

defaultCommandClassName, ERRTASK_NAME, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AddOrderItemComponentsCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompListIds() Returns the oicomplist ids that is used to retrieve the oicomplist entries.
java.lang.Long[]	getComponents() Returns the list of Catalog Entries (components) that will be added to the OrderItem.
java.lang.String	getConfigurationId() Returns the Configuration id that is used to retrieve the components.
java.lang.String	getCurrency() Returns the currency for the price of the components.
OrderItemAccessBean	getOrderItem() Returns the order item access bean that the components will be added to.
java.lang.Long	getOrderItemId() Returns an OrderItem that the components will be added to.
java.util.Vector	getOutComponentList() Gets the output list of components that were created or updated.
java.math.BigDecimal[]	getPrices() Returns a list of price for the components that will be added to the OrderItem.
java.lang.Double[]	getQuantity() Returns a list of quantities of each Catalog Entry (component) that will be added to the OrderItem.
void	performExecute() The main entry point of the command.
void	setCompListIds(java.lang.String astrCompListIds) Sets the oicomplist ids that is used to retrieve the oicomplist entries.
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	setOrderItem(OrderItemAccessBean aOrderItem) Sets the order item access bean that the components will be added to.
void	setOrderItemId(java.lang.Long anOrderItemId) (Optional) Set an OrderItem that the components 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.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AddOrderItemComponentsCmdImpl

public AddOrderItemComponentsCmdImpl()

Method Detail

getOutComponentList

public java.util.Vector getOutComponentList()

Gets the output list of components that were created or updated.

Specified by:

getOutComponentList in interface AddOrderItemComponentsCmd

Returns:

a vector of order item components access bean.

performExecute

public void performExecute()
                    throws ECException

The main entry point of the command.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException.

ECException

setComponents

public void setComponents(java.lang.Long[] anCatentry)

Set a list of Catalog Entries (components) that will be added to the OrderItem.

Specified by:

setComponents in interface AddOrderItemComponentsCmd

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

Specified by:

setConfigurationId in interface AddOrderItemComponentsCmd

Parameters:

astrConfigurationId - the input configuration id.

setCurrency

public void setCurrency(java.lang.String astrCurrency)

(Optional)Sets the currency for the prices of the components.

Specified by:

setCurrency in interface AddOrderItemComponentsCmd

Parameters:

astrCurrency - the input currency

setOrderItemId

public void setOrderItemId(java.lang.Long anOrderItemId)

(Optional) Set an OrderItem that the components will be added to.

Specified by:

setOrderItemId in interface AddOrderItemComponentsCmd

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.

Specified by:

setPrices in interface AddOrderItemComponentsCmd

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.

Specified by:

setQuantity in interface AddOrderItemComponentsCmd

Parameters:

anQuantity - an array of input quantity.

setCompListIds

public void setCompListIds(java.lang.String astrCompListIds)

Sets the oicomplist ids that is used to retrieve the oicomplist entries.

Specified by:

setCompListIds in interface AddOrderItemComponentsCmd

Parameters:

astrCompListIds - the input component list ids.

getCompListIds

public java.lang.String getCompListIds()

Returns the oicomplist ids that is used to retrieve the oicomplist entries.

Returns:

the component list ids.

getComponents

public java.lang.Long[] getComponents()

Returns the list of Catalog Entries (components) that will be added to the OrderItem.

Returns:

the array of catalog entry id.

getConfigurationId

public java.lang.String getConfigurationId()

Returns the Configuration id that is used to retrieve the components.

Returns:

the configuration id.

getCurrency

public java.lang.String getCurrency()

Returns the currency for the price of the components.

Returns:

the currency.

getOrderItemId

public java.lang.Long getOrderItemId()

Returns an OrderItem that the components will be added to.

Returns:

the order item id.

getPrices

public java.math.BigDecimal[] getPrices()

Returns a list of price for the components that will be added to the OrderItem.

Returns:

an array of price for the components.

getQuantity

public java.lang.Double[] getQuantity()

Returns a list of quantities of each Catalog Entry (component) that will be added to the OrderItem.

Returns:

an array of quantity for each Catalog Entry.

getOrderItem

public OrderItemAccessBean getOrderItem()

Returns the order item access bean that the components will be added to.

Returns:

the order item access bean.

setOrderItem

public void setOrderItem(OrderItemAccessBean aOrderItem)

Sets the order item access bean that the components will be added to.

Parameters:

aOrderItem - the order item access bean.