com.ibm.commerce.orderitems.commands

Interface AddOrderItemComponentsCmd

All Superinterfaces:

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

All Known Implementing Classes:

AddOrderItemComponentsCmdImpl

public interface AddOrderItemComponentsCmd
extends TaskCommand

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.

Field Summary

Fields

Modifier and Type	Field and Description
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.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getOutComponentList() Gets the output list of components that were created or updated.
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	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 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, performExecute, 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, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the Command Interface class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class.

See Also:

Constant Field Values

ERRTASK_NAME

static final java.lang.String ERRTASK_NAME

The error task name.

See Also:

Constant Field Values

Method Detail

getOutComponentList

java.util.Vector getOutComponentList()

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

Returns:

Vector a list of components.

setComponents

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

void setConfigurationId(java.lang.String astrConfigurationId)

Sets the configuration id that is used to retrieve the components

Parameters:

astrConfigurationId - the input configuration id.

setCurrency

void setCurrency(java.lang.String astrCurrency)

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

Parameters:

astrCurrency - the input currency

setOrderItemId

void setOrderItemId(java.lang.Long anOrderItemId)

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

Parameters:

anOrderItemId - the input order item id.

setPrices

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

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.

setCompListIds

void setCompListIds(java.lang.String astrCompListIds)

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

Parameters:

astrCompListIds - the input component list ids.