com.ibm.commerce.order.commands
Interface OrderCopyCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
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.


Inner Class Summary
static class OrderCopyCmd.Group
          The OrderCopy enumeration group.
 
Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String ERRCODE_ACCESS_DENIED
           
static java.lang.String ERRCODE_WRONG_STATUS
           
static java.lang.String NAME
           
static java.lang.String ORDER_COPY_ERRVIEW
           
 
Method Summary
 void setBillingAddressId(java.lang.Long anBillingAddressId)
          Set the addressId of the billing address.
 void setCopyOrderInfoFrom(java.lang.String[] astrCopyOrderInfoFrom)
          Set the source order from which the order info (e.g.
 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 enumerationGroups.
An enumerationGroup consists of:
Double idQuantity
Hashtable ihshAttributes
Long inAddressId
Long inCatalogEntryId
Long[] inContractIds
Integer inField1
Long inMemberId
Long[] inOfferIds
Integer inShipmodeId
String istrComment
String[] istrCopyOrderItemAbbreviations
String istrField2
String[] istrFromOrderAbbreviations
String istrPartNumber
String istrUom
String[] istrUpdateOrderItemAbbreviations
These parameters will be passed (as input parameters) to OrderItemUpdate.
 void setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)
          Set the names of the orderItemId NVPs to be appended to the redirection URL.
 void setOutOrderNames(java.lang.String[] astrOutOrderNames)
          Set the names of the orderId NVPs to be appended to the redirection URL.
 void setPayment(java.util.Hashtable ahshPayment)
          Set the payment NVPs of the target order.
 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
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

ERRCODE_ACCESS_DENIED

public static final java.lang.String ERRCODE_ACCESS_DENIED

ERRCODE_WRONG_STATUS

public static final java.lang.String ERRCODE_WRONG_STATUS

NAME

public static final java.lang.String NAME

ORDER_COPY_ERRVIEW

public static final java.lang.String ORDER_COPY_ERRVIEW
Method Detail

setBillingAddressId

public void setBillingAddressId(java.lang.Long anBillingAddressId)
Set the addressId of the billing address.
Parameters:
anBillingAddressId - the addressId.

setCopyOrderInfoFrom

public void setCopyOrderInfoFrom(java.lang.String[] astrCopyOrderInfoFrom)
Set the source order from which the order info (e.g. billingAddress) will be copied.
Parameters:
astrCopyOrderInfoFrom - the source order.

setCopyPaymentInfoFrom

public void setCopyPaymentInfoFrom(java.lang.String[] astrCopyPaymentInfoFrom)
Set the source order from which the payment info will be copied.
Parameters:
astrCopyPaymentInfoFrom - the source order.

setDescription

public void setDescription(java.lang.String astrDescription)
Set the description of the target order.
Parameters:
astrDescription - the description.

setDisplaySequence

public void setDisplaySequence(java.lang.Double adDisplaySequence)
Set the display sequence of the target order.
Parameters:
adDisplaySequence - the display sequence.

setField1

public void setField1(java.lang.Integer anField1)
Set field1 of the target order.
Parameters:
anField1 - the value of field1.

setField2

public void setField2(java.math.BigDecimal adField2)
Set field2 of the target order.
Parameters:
adField2 - the value of field2.

setField3

public void setField3(java.lang.String astrField3)
Set field3 of the target order.
Parameters:
astrField3 - the value of field3.

setGroups

public void setGroups(OrderCopyCmd.Group[] aGroups)
Set the enumerationGroups.
An enumerationGroup consists of:
Double idQuantity
Hashtable ihshAttributes
Long inAddressId
Long inCatalogEntryId
Long[] inContractIds
Integer inField1
Long inMemberId
Long[] inOfferIds
Integer inShipmodeId
String istrComment
String[] istrCopyOrderItemAbbreviations
String istrField2
String[] istrFromOrderAbbreviations
String istrPartNumber
String istrUom
String[] istrUpdateOrderItemAbbreviations
These parameters will be passed (as input parameters) to OrderItemUpdate.
Parameters:
aGroups - the enumerationGroups.

setOutOrderItemNames

public void setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)
Set the names of the orderItemId NVPs to be appended to the redirection URL.
Parameters:
astrOutOrderItemNames - the names of the orderItemId NVPs.

setOutOrderNames

public void setOutOrderNames(java.lang.String[] astrOutOrderNames)
Set the names of the orderId NVPs to be appended to the redirection URL.
Parameters:
astrOutOrderNames - the names of the orderId NVPs.

setPayment

public void setPayment(java.util.Hashtable ahshPayment)
Set the payment NVPs of the target order.
Parameters:
ahshPayment - the payment NVPs.

setStatus

public void setStatus(java.lang.String astrStatus)
Set the status of the target order.
Parameters:
astrStatus - the status ("P" or "I").

setTcId

public 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

public void setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations)
Set the target order.
Parameters:
astrToOrderAbbreviations - the target order.