com.ibm.commerce.order.commands

Interface OrderCopyCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

OrderCopyCmdImpl

public interface OrderCopyCmd
extends ControllerCommand

The OrderCopy command can be used to create new orders or modify existing pending orders by copying information from existing orders. The copied information can be overridden with information provided as parameters to the OrderCopy command. The default implementation of this command is OrderCopyCmdImpl. The OrderCopyCmd URL is mapped to this controller command.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OrderCopyCmd.Group The OrderCopy enumeration group.

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 of this command.
static java.lang.String	ERRCODE_ACCESS_DENIED The ErrorCode value that indicates that the CheckOrderCopyCmd task command denied access to an Order.
static java.lang.String	ERRCODE_WRONG_STATUS The ErrorCode value that indicates that the CheckOrderCopyCmd task command denied access to an Order because it had the wrong status.
static java.lang.String	NAME The name of this command.
static java.lang.String	ORDER_COPY_ERRVIEW The name of the view set when an error is encountered.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getItemsToBeRemoved() Returns the List of Items (Catalog Entry IDs) that needs to be removed from copied items since Inventory is not available and
void	setBillingAddressId(java.lang.Long anBillingAddressId) Set the addressId of the billing address.
void	setBlockInfoCopyFlag(java.lang.String astrBlockInfoCopyFlag) Set the block info copy flag
void	setContinue(java.lang.String astrContinue) Set the continue parameter (optional).
void	setCopyOrderInfoFrom(java.lang.String[] astrCopyOrderInfoFrom) Set the source order from which the order info (for example billingAddress) will be copied.
void	setCopyOrderPromotionCodeFrom(java.lang.String[] astrCopyOrderPromotionCodeFrom) Set the source order from which the order promotion codes are copied.
void	setCopyPaymentInfoFrom(java.lang.String[] astrCopyPaymentInfoFrom) Set the source order from which the payment info will be copied.
void	setDescription(java.lang.String astrDescription) Set the description of the target order.
void	setDisplaySequence(java.lang.Double adDisplaySequence) Set the display sequence of the target order.
void	setField1(java.lang.Integer anField1) Set field1 of the target order.
void	setField2(java.math.BigDecimal adField2) Set field2 of the target order.
void	setField3(java.lang.String astrField3) Set field3 of the target order.
void	setGroups(OrderCopyCmd.Group[] aGroups) Set the enumeration groups.
void	setOrderComment(java.lang.String astrOrderComment) Set the order comment (optional).
void	setOrderPromotionCodeCopyFlag(java.lang.String astrOrderPromotionCodeCopyFlag) Set the order promotion code copy flag.
void	setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames) Sets the names of the orderItemId properties to be appended to the redirection URL.
void	setOutOrderNames(java.lang.String[] astrOutOrderNames) Sets the names of the orderId properties to be appended to the redirection URL.
void	setPayment(java.util.Hashtable ahshPayment) Set the payment information of the target order.
void	setSensitiveInfoCopyFlag(java.lang.String astrSensitiveInfoCopyFlag) Set the sensitive info copy flag
void	setStatus(java.lang.String astrStatus) Set the status of the target order.
void	setTcId(java.lang.Long anTcId) Set the PaymentTC that the billing address will be checked against.
void	setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations) Set the target order.

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

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.CommandCaller

unionDependencies

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

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

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

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

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 this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

ORDER_COPY_ERRVIEW

static final java.lang.String ORDER_COPY_ERRVIEW

The name of the view set when an error is encountered. This view must be able to display appropriate messages for the error codes defined by this class.

The error code is the value of a property named ErrorCode.

Further detail about the error is contained in properties with names specific to each error code.

See Also:

Constant Field Values

ERRCODE_ACCESS_DENIED

static final java.lang.String ERRCODE_ACCESS_DENIED

The ErrorCode value that indicates that the CheckOrderCopyCmd task command denied access to an Order.

The identifier of the Order that was denied is provided as the value of the orderId property.

See Also:

Constant Field Values

ERRCODE_WRONG_STATUS

static final java.lang.String ERRCODE_WRONG_STATUS

The ErrorCode value that indicates that the CheckOrderCopyCmd task command denied access to an Order because it had the wrong status.

The identifier of the Order that was denied is provided as the value of the orderId property.

See Also:

Constant Field Values

Method Detail

setBillingAddressId

void setBillingAddressId(java.lang.Long anBillingAddressId)

Set the addressId of the billing address.

Parameters:

anBillingAddressId - the addressId.

setCopyOrderInfoFrom

void setCopyOrderInfoFrom(java.lang.String[] astrCopyOrderInfoFrom)

Set the source order from which the order info (for example billingAddress) will be copied.

Parameters:

astrCopyOrderInfoFrom - the source order.

setCopyPaymentInfoFrom

void setCopyPaymentInfoFrom(java.lang.String[] astrCopyPaymentInfoFrom)

Set the source order from which the payment info will be copied.

Parameters:

astrCopyPaymentInfoFrom - the source order.

setDescription

void setDescription(java.lang.String astrDescription)

Set the description of the target order.

Parameters:

astrDescription - the description.

setDisplaySequence

void setDisplaySequence(java.lang.Double adDisplaySequence)

Set the display sequence of the target order.

Parameters:

adDisplaySequence - the display sequence.

setField1

void setField1(java.lang.Integer anField1)

Set field1 of the target order.

Parameters:

anField1 - the value of field1.

setField2

void setField2(java.math.BigDecimal adField2)

Set field2 of the target order.

Parameters:

adField2 - the value of field2.

setField3

void setField3(java.lang.String astrField3)

Set field3 of the target order.

Parameters:

astrField3 - the value of field3.

setGroups

void setGroups(OrderCopyCmd.Group[] aGroups)

Set the enumeration groups.
An enumeration group contains information used to construct parameters that will be passed to the items.commands.OrderItemUpdateCmd task command.

Parameters:

aGroups - the enumeration groups.

setOutOrderItemNames

void setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)

Sets the names of the orderItemId properties to be appended to the redirection URL. Each name causes properties to be appended to the redirection URL with the specified name. And with values of the OrderItemIds that were created or updated.

Parameters:

astrOutOrderItemNames - the names of the orderItemId properties.

setOutOrderNames

void setOutOrderNames(java.lang.String[] astrOutOrderNames)

Sets the names of the orderId properties to be appended to the redirection URL. Each name causes properties to be appended to the redirection URL with the specified name. And with values of the OrderId that was created or updated.

Parameters:

astrOutOrderNames - the names of the orderId properties.

setPayment

void setPayment(java.util.Hashtable ahshPayment)

Set the payment information of the target order.

Parameters:

ahshPayment - the payment information.

Key: payment information name (String).

Value: payment information values (String[] ) .

setStatus

void setStatus(java.lang.String astrStatus)

Set the status of the target order.

Parameters:

astrStatus - the status ("P" or "I").

setTcId

void setTcId(java.lang.Long anTcId)

Set the PaymentTC that the billing address will be checked against.

Parameters:

anTcId - the tcId of the PaymentTC

setToOrderAbbreviations

void setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations)

Set the target order.

Parameters:

astrToOrderAbbreviations - the target order.

setContinue

void setContinue(java.lang.String astrContinue)

Set the continue parameter (optional). If an OrderItem cannot be created or updated in the target Order,
0 - terminate execution and rollback.
1 - ignore the create or update operation for that OrderItem and continue execution.

Parameters:

astrContinue - the continue parameter. Default is "0".

setOrderComment

void setOrderComment(java.lang.String astrOrderComment)

Set the order comment (optional).

Parameters:

astrOrderComment - the order comment.

getItemsToBeRemoved

java.util.Vector getItemsToBeRemoved()

Returns the List of Items (Catalog Entry IDs) that needs to be removed from copied items since Inventory is not available and

Returns:

Vector the order items to be removed

setSensitiveInfoCopyFlag

void setSensitiveInfoCopyFlag(java.lang.String astrSensitiveInfoCopyFlag)

Set the sensitive info copy flag

Parameters:

astrSensitiveInfoCopyFlag - sensitive info copy flag

setBlockInfoCopyFlag

void setBlockInfoCopyFlag(java.lang.String astrBlockInfoCopyFlag)

Set the block info copy flag

Parameters:

astrBlockInfoCopyFlag - block info copy flag

setOrderPromotionCodeCopyFlag

void setOrderPromotionCodeCopyFlag(java.lang.String astrOrderPromotionCodeCopyFlag)

Set the order promotion code copy flag. The default value is "N" indicating the promotion codes need not be copied. If it is set as "Y", the order promotion code need to be copied to the target order.

Parameters:

astrOrderPromotionCodeCopyFlag - the order promotion code copy flag.

setCopyOrderPromotionCodeFrom

void setCopyOrderPromotionCodeFrom(java.lang.String[] astrCopyOrderPromotionCodeFrom)

Set the source order from which the order promotion codes are copied.

Parameters:

astrCopyOrderPromotionCodeFrom - the array of source orders.