RecordOrderHistoryTaskCmd

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:: RecordOrderHistoryTaskCmdImpl

public interface RecordOrderHistoryTaskCmd
extends TaskCommand

This task command is used to record the Order history info as an XML tree. The default implementation of this command is RecordOrderHistoryTaskCmdImpl.
XSD of the order history XML is below

<?xml version="1.0" encoding="UTF-8"?> 
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.ibm.com/WebSphereCommerce" xmlns:wc="http://www.ibm.com/WebSphereCommerce">
        <xsd:element name="Order">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="ORDERS_ID" />
                                <xsd:element name="ORMORDER" minOccurs="0" />
                                <xsd:element name="ORGENTITY_ID" minOccurs="0" />
                                <xsd:element name="TOTALPRODUCT" minOccurs="0" />
                                <xsd:element name="TOTALTAX" minOccurs="0" />
                                <xsd:element name="TOTALSHIPPING" minOccurs="0" />
                                <xsd:element name="TOTALTAXSHIPPING" minOccurs="0" />
                                <xsd:element name="DESCRIPTION" minOccurs="0" />
                                <xsd:element name="STOREENT_ID" minOccurs="0" />
                                <xsd:element name="CURRENCY" minOccurs="0" />
                                <xsd:element name="LOCKED" minOccurs="0" />
                                <xsd:element name="TIMEPLACED" minOccurs="0" />
                                <xsd:element name="LASTUPDATE" minOccurs="0" />
                                <xsd:element name="sequence" minOccurs="0" />
                                <xsd:element name="STATUS" minOccurs="0" />
                                <xsd:element name="MEMBER_ID" minOccurs="0" />
                                <xsd:element name="FIELD1" minOccurs="0" />
                                <xsd:element name="ADDRESS_ID" minOccurs="0" />
                                <xsd:element name="FIELD2" minOccurs="0" />
                                <xsd:element name="PROVIDERORDERNUM" minOccurs="0" />
                                <xsd:element name="SHIPASCOMPLETE" minOccurs="0" />
                                <xsd:element name="FIELD3" minOccurs="0" />
                                <xsd:element name="TOTALADJUSTMENT" minOccurs="0" />
                                <xsd:element name="ORDCHNLTYP_ID" minOccurs="0" />
                                <xsd:element name="COMMENTS" minOccurs="0" />
                                <xsd:element name="NOTIFICATIONID" minOccurs="0" />
                                <xsd:element ref="wc:OrderItems" minOccurs="0"></xsd:element>
                                <xsd:element ref="wc:PaymentInfos" minOccurs="0"></xsd:element>
                                <xsd:element ref="wc:ShipInfos" minOccurs="0"></xsd:element>
                                <xsd:element ref="wc:caladjustments" minOccurs="0"></xsd:element>
<xsd:element name="OrderCustomizeField " minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>

        <xsd:element name="OrderItems">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:OrderItem" maxOccurs="unbounded" minOccurs="0"></xsd:element>
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element> 

        <xsd:element name="PaymentInfos">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:PaymentInfo" maxOccurs="unbounded" minOccurs="0"></xsd:element>
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>

        <xsd:element name="ShipInfos">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:ShipInfo" maxOccurs="unbounded" minOccurs="0"></xsd:element>
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>
        <xsd:element name="caladjustments">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:caladjustment" maxOccurs="unbounded" minOccurs="0"></xsd:element>
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>
        <xsd:element name="OrderItem">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="ORDERITEMS_ID" />
                                <xsd:element name="STOREENT_ID" minOccurs="0" />
                                <xsd:element name="ORDERS_ID" minOccurs="0" />
                                <xsd:element name="TERMCOND_ID" minOccurs="0" />
                                <xsd:element name="TRADING_ID" minOccurs="0" />
                                <xsd:element name="ITEMSPC_ID" minOccurs="0" />
                                <xsd:element name="CATENTRY_ID" minOccurs="0" />
                                <xsd:element name="PARTNUM" minOccurs="0" />
                                <xsd:element name="SHIPMODE_ID" minOccurs="0" />
                                <xsd:element name="FFMCENTER_ID" minOccurs="0" />
                                <xsd:element name="MEMBER_ID" minOccurs="0" />
                                <xsd:element name="ADDRESS_ID" minOccurs="0" />
                                <xsd:element name="ALLOCADDRESS_ID" minOccurs="0" />
                                <xsd:element name="PRICE" minOccurs="0" /> 
                                <xsd:element name="LINEITEMTYPE" minOccurs="0" />
                                <xsd:element name="STATUS" minOccurs="0" />
                                <xsd:element name="OUTPUTQ_ID" minOccurs="0" />
                                <xsd:element name="INVENTORYSTATUS" minOccurs="0" />
                                <xsd:element name="LASTCREATE" minOccurs="0" />
                                <xsd:element name="LASTUPDATE" minOccurs="0" />
                                <xsd:element name="FULFILLMENTSTATUS" minOccurs="0" />
                                <xsd:element name="LASTALLOCUPDATE" minOccurs="0" />
                                <xsd:element name="OFFER_ID" minOccurs="0" />
                                <xsd:element name="TIMERELEASED" minOccurs="0" />
                                <xsd:element name="TIMESHIPPED" minOccurs="0" />
                                <xsd:element name="CURRENCY" minOccurs="0" />
                                <xsd:element name="COMMENTS" minOccurs="0" />
                                <xsd:element name="TOTALPRODUCT" minOccurs="0" />
                                <xsd:element name="QUANTITY" minOccurs="0" />
                                <xsd:element name="TAXAMOUNT" minOccurs="0" />
                                <xsd:element name="TOTALADJUSTMENT" minOccurs="0" />
                                <xsd:element name="SHIPTAXAMOUNT" minOccurs="0" />
                                <xsd:element name="ESTAVAILTIME" minOccurs="0" />
                                <xsd:element name="FIELD1" minOccurs="0" />
                                <xsd:element name="DESCRIPTION" minOccurs="0" />
                                <xsd:element name="FIELD2" minOccurs="0" />
                                <xsd:element name="ALLOCATIONGROUP" minOccurs="0" />
                                <xsd:element name="BASEPRICE" minOccurs="0" />
                                <xsd:element name="BASECURRENCY" minOccurs="0" />
                                <xsd:element name="TRACKNUMBER" minOccurs="0" />
                                <xsd:element name="TRACKDATE" minOccurs="0" />
                                <xsd:element name="PREPAREFLAGS" minOccurs="0" />
                                <xsd:element name="CORRELATIONGROUP" minOccurs="0" />
                                <xsd:element name="PROMISEDAVAILTIME" minOccurs="0" />
                                <xsd:element name="SHIPPINGOFFSET" minOccurs="0" />
                                <xsd:element name="NEEDEDQUANTITY" minOccurs="0" />
                                <xsd:element name="ALLOCQUANTITY" minOccurs="0" />
                                <xsd:element name="ALLOCFFMC_ID" minOccurs="0" />
                                <xsd:element name="ORDRELEASENUM" minOccurs="0" />
                                <xsd:element name="CONFIGURATIONID" minOccurs="0" />
                                <xsd:element name="SUPPLIERDATA" minOccurs="0" />
                                <xsd:element name="SUPPLIERPARTNUMBER" minOccurs="0" />
                                <xsd:element name="AVAILQUANTITY" minOccurs="0" />
                                <xsd:element ref="wc:OICOMPLIST" minOccurs="0" />
                                <xsd:element ref="wc:Pattrvalues" minOccurs="0" />
<xsd:element name="OrderItemCustomizeField " minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element> 

        <xsd:element name="PaymentInfo">
                <xsd:complexType> 
                        <xsd:sequence>
                                <xsd:element name="paymentInstruction_ID" />
                                <xsd:element name="paymentMethodName" minOccurs="0" />
                                <xsd:element name="paymentPolicy_ID" minOccurs="0" />
                                <xsd:element name="sequenceNumber" minOccurs="0" />
                                <xsd:element name="cardNumber" minOccurs="0" />
                                <xsd:element name="amount" minOccurs="0" />
                                <xsd:element name=" currency" minOccurs="0" />
<xsd:element name="status " minOccurs="0" />
<xsd:element name="approvedAmount " minOccurs="0" />
<xsd:element name="approvingAmount " minOccurs="0" />
<xsd:element name=" reversingApprovedAmount" minOccurs="0" />
<xsd:element name=" depositedAount" minOccurs="0" />
<xsd:element name=" depositingAmount" minOccurs="0" />
<xsd:element name="reversingDepositedAmount " minOccurs="0" />
<xsd:element name="creditingAmount " minOccurs="0" />
<xsd:element name=" creditedAmount" minOccurs="0" />
<xsd:element name="reversingCreditedAmount " minOccurs="0" />
<xsd:element name="cancelFlag" minOccurs="0" />
<xsd:element name=" overallPaymentInstructionStatus " minOccurs="0" />
<xsd:element name="valid" minOccurs="0" />
<xsd:element name=" protocolDataMap" minOccurs="0" />
<xsd:element name="paymentcustomizeField " minOccurs="0" />
                        </xsd:sequence>
</xsd:complexType>
        </xsd:element>

        <xsd:element name="ShipInfo">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="SHIPINFO_ID" />
                                <xsd:element name="ORDERS_ID" minOccurs="0" />
                                <xsd:element name="ADDRESS_ID" minOccurs="0" />
                                <xsd:element name="POLICY_ID" minOccurs="0" />
                                <xsd:element name="SHIPMODE_ID" minOccurs="0" />
                                <xsd:element name="CARRIERACCNTNUM" minOccurs="0" />
                                <xsd:element name="INSTRUCTIONS" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element> 

        <xsd:element name="OICOMPLIST">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:OrderItemComponent" maxOccurs="unbounded" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element> 

        <xsd:element name="OrderItemComponent">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="ITEMSPC_ID" minOccurs="0" />
                                <xsd:element name="OICOMPLIST_ID" />
                                <xsd:element name="CATENTRY_ID" minOccurs="0" />
                                <xsd:element name="ORDERITEMS_ID" minOccurs="0" />
                                <xsd:element name="CATALOGQUANTITY" minOccurs="0" />
                                <xsd:element name="INVENTORYQUANTITY" minOccurs="0" />
                                <xsd:element name="REQUIRED" minOccurs="0" />
                                <xsd:element name="CONFIGURATIONID" minOccurs="0" />
                                <xsd:element name="CURRENCY" minOccurs="0" />
                                <xsd:element name="SUPPLIERDATA" minOccurs="0" />
                                <xsd:element name="SUPPLIERPARTNUMBER" minOccurs="0" />
                                <xsd:element name="RFQPROD_ID" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>

        <xsd:element name="Pattrvalues">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element ref="wc:Pattrvalue" maxOccurs="unbounded" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>

        <xsd:element name="Pattrvalue">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="PATTRVALUE_ID" />
                                <xsd:element name="PATTRIBUTE_ID" />
                                <xsd:element name="ATTRTYPE_ID" />
                                <xsd:element name="OPERATOR_ID" />
                                <xsd:element name="TERMCOND_ID" minOccurs="0" />
                                <xsd:element name="QTYUNIT_ID" minOccurs="0" />
                                <xsd:element name="INTEGERVALUE" minOccurs="0" />
                                <xsd:element name="FLOATVALUE" minOccurs="0" />
                                <xsd:element name="STRINGVALUE" minOccurs="0" />
                                <xsd:element name="DATEVALUE" minOccurs="0" />
                                <xsd:element name="BIGINTVALUE" minOccurs="0" />
                                <xsd:element name="SEQUENCE" minOccurs="0" />
                                <xsd:element name="ENCRYPTFLAG" minOccurs="0" />
                                <xsd:element name="ORDERITEMS_ID" minOccurs="0" />
                                <xsd:element name="MANDATORY" minOccurs="0" />
                                <xsd:element name="ATTACHMENT_ID" minOccurs="0" />
                                <xsd:element name="CHANGEABLE" minOccurs="0" />
                                <xsd:element name="RFQPROD_ID" minOccurs="0" />
                                <xsd:element name="RFQRSPPROD_ID" minOccurs="0" />
                                <xsd:element name="CORRELATIONGROUP" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element> 

        <xsd:element name="caladjustment">
                <xsd:complexType>
                        <xsd:sequence>
                                <xsd:element name="CALADJUST_ID" />
                                <xsd:element name="ORDERS_ID" minOccurs="0" />
                                <xsd:element name="CALUSAGE_ID" minOccurs="0" />
                                <xsd:element name="SHIPMODE_ID" minOccurs="0" />
                                <xsd:element name="SERVICEREP_ID" minOccurs="0" />
                                <xsd:element name="PARMTYPE" minOccurs="0" />
                                <xsd:element name="PARMAMT" minOccurs="0" />
                                <xsd:element name="FIELD1" minOccurs="0" />
                                <xsd:element name="FIELD2" minOccurs="0" />
                                <xsd:element name="BASECOST" minOccurs="0" />
                        </xsd:sequence>
                </xsd:complexType>
        </xsd:element>
</xsd:schema>

See Also:: RecordOrderHistoryTaskCmdImpl

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.
`static java.lang.String`	`defaultCommandClassName` The default implementation of this command.
`static java.lang.String`	`NAME` The full name of this command.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HistoryOrder`	`getHistoryOrder()` This method returns the order XML representation from this command.
`OrderHistoryAccessBean`	`getOrderHistory()` This method returns the order history out of this command.
`java.lang.Short`	`getOrderVersion()` This method returns the order version produced in this command.
`void`	`setCustomizableXMLRecordableObject(XMLRecordable recordable)` This method sets the Customizable object.
`void`	`setLastupdate(java.sql.Timestamp lastUpdate)` This method sets the created time for the history Order.
`void`	`setOrder(OrderAccessBean abOrder)` This method sets an order as a history Order

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
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    The full 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
- Method Detail
  - getOrderHistory
```
OrderHistoryAccessBean getOrderHistory()
```
    This method returns the order history out of this command.
    
    Returns:
    
    An OrderHistoryAccessBean that represents the created order history object.
  - getHistoryOrder
```
HistoryOrder getHistoryOrder()
```
    This method returns the order XML representation from this command.
    
    Returns:
    
    A HistoryOrder that represents the order XML wrapper.
  - getOrderVersion
```
java.lang.Short getOrderVersion()
```
    This method returns the order version produced in this command.
    
    Returns:
    
    A Short that specifies the Order version.
  - setOrder
```
void setOrder(OrderAccessBean abOrder)
```
    This method sets an order as a history Order
    
    Parameters:
    
    abOrder - An OrderAccessBean that represents the order to be recorded as a history Order.
  - setLastupdate
```
void setLastupdate(java.sql.Timestamp lastUpdate)
```
    This method sets the created time for the history Order.
    
    Parameters:
    
    lastUpdate - A Timestamp that represents last update time.
  - setCustomizableXMLRecordableObject
```
void setCustomizableXMLRecordableObject(XMLRecordable recordable)
```
    This method sets the Customizable object.
    
    Parameters:
    
    recordable - An XMLRecordable that represents the Customizable object.

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

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

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

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

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

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

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

COPYRIGHT

NAME

defaultCommandClassName

getOrderHistory

getHistoryOrder

getOrderVersion

setOrder

setLastupdate

setCustomizableXMLRecordableObject