com.ibm.commerce.order.history

Class HistoryOrder

  • java.lang.Object
    • com.ibm.commerce.order.history.HistoryOrder
  • All Implemented Interfaces:
    XMLRecordable


    public class HistoryOrder
    extends java.lang.Object
    implements XMLRecordable
    This class is used to track order history adjustment information. It can be used to get the XML element from an com.ibm.commerce.order.objects.OrderAccessBean or get HistoryOrder from the XML.
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice fields.
        See Also:
        Constant Field Values
    • Constructor Detail

      • HistoryOrder

        public HistoryOrder()
    • Method Detail

      • getAddressId

        public java.lang.Long getAddressId()
        This method returns address id of the order.
        Returns:
        address Id of the order.
      • getBuschnId

        public java.lang.Integer getBuschnId()
        This method returns business channel Id of the order.
        Returns:
        the business channel Id of the order.
      • getComment

        public java.lang.String getComment()
        This method returns comment of the order.
        Returns:
        comment of the order.
      • getCurrency

        public java.lang.String getCurrency()
        This method returns currency of the order.
        Returns:
        currency of the order.
      • getDescription

        public java.lang.String getDescription()
        Gets description
        Returns:
        description
      • getEditorId

        public java.lang.Long getEditorId()
        Gets editor id
        Returns:
        editorId
      • getExpireDate

        public java.sql.Timestamp getExpireDate()
        Gets expire date
        Returns:
        expire Date
      • getField1

        public java.lang.Integer getField1()
        Gets field1
        Returns:
        field1
      • getField2

        public java.math.BigDecimal getField2()
        Gets field2
        Returns:
        field2
      • getField3

        public java.lang.String getField3()
        Gets field3
        Returns:
        field3
      • getBlocked

        public java.lang.Short getBlocked()
        Gets blocked
        Returns:
        blocked
      • getLastUpdate

        public java.sql.Timestamp getLastUpdate()
        Gets last update timestamp
        Returns:
        lastUpdate
      • getLock

        public java.lang.String getLock()
        Gets lock
        Returns:
        lock
      • getTransferStatus

        public java.lang.Short getTransferStatus()
        Gets transfer status
        Returns:
        transferStatus
      • getMemberId

        public java.lang.Long getMemberId()
        Gets member id
        Returns:
        memberId
      • getMerchantOrderId

        public java.lang.String getMerchantOrderId()
        Gets merchant order id
        Returns:
        merchant Order Id
      • getOrderChannelTypeId

        public java.lang.Long getOrderChannelTypeId()
        Gets order channel type id
        Returns:
        order Channel Type Id
      • getOrderId

        public java.lang.Long getOrderId()
        Gets order id
        Returns:
        order Id
      • getOrganizationId

        public java.lang.Long getOrganizationId()
        Gets organization id
        Returns:
        organization Id
      • getPlaceOrderTime

        public java.sql.Timestamp getPlaceOrderTime()
        Gets place order time
        Returns:
        place Order Time
      • getProviderOrderNumber

        public java.lang.Integer getProviderOrderNumber()
        Gets provider order number
        Returns:
        provider Order Number
      • getSequence

        public java.lang.Double getSequence()
        Gets sequence
        Returns:
        sequence
      • getShipAsComplete

        public java.lang.String getShipAsComplete()
        Gets shipAsComplete
        Returns:
        ship As Complete - Y(Yes) or N(NO)
      • getSourceId

        public java.lang.Long getSourceId()
        Gets sourceId
        Returns:
        sourceId
      • getStatus

        public java.lang.String getStatus()
        Gets status
        Returns:
        status
      • getStoreEntityId

        public java.lang.Integer getStoreEntityId()
        Returns:
        storeEntityId
      • getTotalAdjustment

        public java.math.BigDecimal getTotalAdjustment()
        Returns:
        totalAdjustment
      • getTotalProductPrice

        public java.math.BigDecimal getTotalProductPrice()
        Returns:
        totalProductPrice
      • getTotalShippingCharge

        public java.math.BigDecimal getTotalShippingCharge()
        Returns:
        totalShippingCharge
      • getTotalShippingTax

        public java.math.BigDecimal getTotalShippingTax()
        Returns:
        totalShippingTax
      • getTotalTax

        public java.math.BigDecimal getTotalTax()
        Returns:
        totalTax
      • getType

        public java.lang.String getType()
        Returns:
        type
      • setAddressId

        public void setAddressId(java.lang.Long long1)
        Sets addressId
        Parameters:
        long1 - addressId
      • setBuschnId

        public void setBuschnId(java.lang.Integer integer)
        Sets business channel Id
        Parameters:
        integer - business channel Id
      • setComment

        public void setComment(java.lang.String string)
        Sets comment
        Parameters:
        string - comment
      • setCurrency

        public void setCurrency(java.lang.String string)
        Sets currency
        Parameters:
        string - currency - USD, CAD, CHY and so forth.
      • setDescription

        public void setDescription(java.lang.String string)
        Sets description
        Parameters:
        string - description
      • setEditorId

        public void setEditorId(java.lang.Long argEditorId)
        Sets editorId
        Parameters:
        argEditorId - editorId
      • setExpireDate

        public void setExpireDate(java.sql.Timestamp timestamp)
        Sets expireDate
        Parameters:
        timestamp - expireDate
      • setField1

        public void setField1(java.lang.Integer argField1)
        Sets field1
        Parameters:
        argField1 -
      • setField2

        public void setField2(java.math.BigDecimal decimal)
        Sets field2
        Parameters:
        decimal - field2
      • setField3

        public void setField3(java.lang.String string)
        Sets field3
        Parameters:
        string - field3
      • setHistoryOrderItem

        public void setHistoryOrderItem(java.util.Vector vector)
        Sets a vector of HistoryOrderItem
        Parameters:
        vector - HistoryOrderItem
      • setHistoryShipInfo

        public void setHistoryShipInfo(java.util.Vector vector)
        Sets a vector of HistoryShipInfo
        Parameters:
        vector - HistoryShipInfo
      • setBlocked

        public void setBlocked(java.lang.Short short1)
        Sets blocked - 1 blocked, 0 not blocked.
        Parameters:
        short1 - blocked
      • setLastUpdate

        public void setLastUpdate(java.sql.Timestamp timestamp)
        Sets last Update timeStamp
        Parameters:
        timestamp - lastUpdate
      • setLock

        public void setLock(java.lang.String string)
        Sets lock or not - "0" not locked, "1" locked
        Parameters:
        string - lock
      • setMemberId

        public void setMemberId(java.lang.Long argMemberId)
        Sets member Id
        Parameters:
        argMemberId -
      • setMerchantOrderId

        public void setMerchantOrderId(java.lang.String string)
        Sets merchant Order Id
        Parameters:
        string - merchantOrderId
      • setOrderChannelTypeId

        public void setOrderChannelTypeId(java.lang.Long long1)
        Sets order Channel Type Id
        Parameters:
        long1 - orderChannelTypeId
      • setOrderId

        public void setOrderId(java.lang.Long long1)
        Sets organizationId
        Parameters:
        long1 - organizationId
      • setOrganizationId

        public void setOrganizationId(java.lang.Long long1)
        Parameters:
        long1 -
      • setPlaceOrderTime

        public void setPlaceOrderTime(java.sql.Timestamp timestamp)
        Sets place Order Time
        Parameters:
        timestamp - placeOrderTime
      • setProviderOrderNumber

        public void setProviderOrderNumber(java.lang.Integer integer)
        Sets provider Order Number
        Parameters:
        integer - provider Order Number
      • setSequence

        public void setSequence(java.lang.Double double1)
        Sets sequence
        Parameters:
        double1 - sequence
      • setShipAsComplete

        public void setShipAsComplete(java.lang.String string)
        Sets shipAsComplete
        Parameters:
        string - shipAsComplete
      • setSourceId

        public void setSourceId(java.lang.Long long1)
        Sets source Id of the order
        Parameters:
        long1 - sourceId
      • setStatus

        public void setStatus(java.lang.String string)
        Sets status of the order
        Parameters:
        string - status
      • setStoreEntityId

        public void setStoreEntityId(java.lang.Integer integer)
        Sets store Entity Id
        Parameters:
        integer - storeEntityId
      • setTotalAdjustment

        public void setTotalAdjustment(java.math.BigDecimal decimal)
        Sets total Adjustment
        Parameters:
        decimal - totalAdjustment
      • setTotalProductPrice

        public void setTotalProductPrice(java.math.BigDecimal decimal)
        Set total Product Price
        Parameters:
        decimal - totalProductPrice
      • setTotalShippingCharge

        public void setTotalShippingCharge(java.math.BigDecimal decimal)
        Sets Total Shipping Charge
        Parameters:
        decimal - totalShippingCharge
      • setTotalShippingTax

        public void setTotalShippingTax(java.math.BigDecimal decimal)
        Sets Total Shipping Tax
        Parameters:
        decimal - totalShippingTax
      • setTotalTax

        public void setTotalTax(java.math.BigDecimal decimal)
        Sets Total Tax
        Parameters:
        decimal - totalTax
      • setType

        public void setType(java.lang.String string)
        Set type
        Parameters:
        string - type
      • toXML

        public java.lang.String toXML()
        Converts this object into an XML format representation.
        Specified by:
        toXML in interface XMLRecordable
        Returns:
        the an XML string represents this object.
        See Also:
        XMLRecordable.toXML()
      • fieldsToXML

        public java.lang.String fieldsToXML()
        Converts only this object's fields into an XML format representation.
        Specified by:
        fieldsToXML in interface XMLRecordable
        Returns:
        an XML string just represents this objects's fields.
        See Also:
        XMLRecordable.fieldsToXML()
      • getNotificationId

        public java.lang.Long getNotificationId()
        Gets the notificationId
        Returns:
        notificationId
      • setNotificationId

        public void setNotificationId(java.lang.Long argNotificationId)
        Sets the notificationId
        Parameters:
        argNotificationId -
      • getVecHistoryCalculationAdjustment

        public java.util.Vector getVecHistoryCalculationAdjustment()
        Gets Vector HistoryCalculationAdjustment
        Returns:
        Vector HistoryCalculationAdjustment
      • getVecHistoryOrderItem

        public java.util.Vector getVecHistoryOrderItem()
        Gets Vector HistoryOrderItem
        Returns:
        Vector HistoryOrderItem
      • getVecHistoryPaymentInformation

        public java.util.Vector getVecHistoryPaymentInformation()
        Gets Vector HistoryPaymentInformation
        Returns:
        a Vector of HistoryPaymentInformation
      • getVecHistoryShipInfo

        public java.util.Vector getVecHistoryShipInfo()
        Gets Vector HistoryShipInfo
        Returns:
        a vector of HistoryShipInfo
      • setVecHistoryCalculationAdjustment

        public void setVecHistoryCalculationAdjustment(java.util.Vector vectorHistoryCalculationAdjustment)
        Sets vector HistoryCalculationAdjustment
        Parameters:
        vectorHistoryCalculationAdjustment -
      • setVecHistoryOrderItem

        public void setVecHistoryOrderItem(java.util.Vector vectorHistoryOrderItem)
        Sets vector HistoryOrderItem
        Parameters:
        vectorHistoryOrderItem -
      • setVecHistoryPaymentInformation

        public void setVecHistoryPaymentInformation(java.util.Vector vectorHistoryPaymentInformation)
        Sets vector HistoryPaymentInformation
        Parameters:
        vectorHistoryPaymentInformation -
      • setVecHistoryShipInfo

        public void setVecHistoryShipInfo(java.util.Vector vectorHistoryShipInfo)
        Sets vector HistoryShipInfo
        Parameters:
        vectorHistoryShipInfo -
      • setOtherRecordableObject

        public void setOtherRecordableObject(XMLRecordable recordablObject)
        Sets the customizable object.
        Parameters:
        recordablObject -
      • getCommandContext

        public CommandContext getCommandContext()
        Gets the Command Context
        Returns:
        iCommandContext
      • setCommandContext

        public void setCommandContext(CommandContext context)
        Sets Command Context
        Parameters:
        context -
      • setTransferStatus

        public void setTransferStatus(java.lang.Short argTransferStatus)
        Sets TransferStatus
        Parameters:
        argTransferStatus -
      • getOtherRecordableObject

        public XMLRecordable getOtherRecordableObject()
        Gets the customizable object.
        Returns:
        customizable object
      • getOrderProcessSystemId

        public java.lang.Integer getOrderProcessSystemId()
        Gets purchase order id
        Returns:
        orderProcessSystemId
      • getPurchaseOrderId

        public java.lang.Long getPurchaseOrderId()
        Gets purchase order id
        Returns:
        purchaseOrderId
      • setOrderProcessSystemId

        public void setOrderProcessSystemId(java.lang.Integer integer)
        Sets order process system id
        Parameters:
        integer - orderProcessSystemId
      • setPurchaseOrderId

        public void setPurchaseOrderId(java.lang.Long long1)
        Sets buyer purchase order id
        Parameters:
        long1 - purchaseOrderId
      • getVecHistoryOrderBlock

        public java.util.Vector getVecHistoryOrderBlock()
        Returns:
        Returns the vecHistoryOrderBlock.
      • setVecHistoryOrderBlock

        public void setVecHistoryOrderBlock(java.util.Vector argVecHistoryOrderBlock)
        Parameters:
        argVecHistoryOrderBlock - The vecHistoryOrderBlock to set.
      • getCurrentPage

        public int getCurrentPage()
        This method returns current page number.
        Returns:
        the current page number.
      • getPageSize

        public int getPageSize()
        This method returns page size.
        Returns:
        the page size.
      • setCurrentPage

        public void setCurrentPage(int i)
        This method sets current page number.
        Parameters:
        i - the current page number.
      • setPageSize

        public void setPageSize(int i)
        This method sets page size.
        Parameters:
        i - the page size.
      • getTotalPages

        public int getTotalPages()
        This method returns the total number of pages.
        Returns:
        the total number of pages.
      • getTotalSize

        public int getTotalSize()
        This method returns the total size of history order items.
        Returns:
        the total size of history order items.
      • getHistoryOrderItemsByPageNumber

        public HistoryOrderItem[] getHistoryOrderItemsByPageNumber(int pageNum)
                                                            throws java.lang.Exception
        This method returns an array of history order items by the page number.
        Parameters:
        pageNum - the page number.
        Returns:
        the array of history order items.
        Throws:
        java.lang.Exception - It is thrown when an error occurs.
      • getHistoryOrderItemsInCurrentPage

        public HistoryOrderItem[] getHistoryOrderItemsInCurrentPage()
                                                             throws java.lang.Exception
        This method returns an array of history order items in current page number.
        Returns:
        the array of history order items.
        Throws:
        java.lang.Exception - It is thrown when an error occurs.
      • getHistoryOrderItems

        public HistoryOrderItem[] getHistoryOrderItems(int startIndex,
                                                       int endIndex)
                                                throws java.lang.Exception
        This method returns an array of history order items from the specified startIndex inclusive and endIndex exclusive. It is used for pagination of history order items.
        For example, there are 10 order items in the specified history order. If user wants to get the first three order items with index 0, 1, 2; the user could use getHistoryOrderItems(0,3).
        Parameters:
        startIndex - the start index from 0.
        endIndex - the end index.
        Returns:
        the array of history order items.
        Throws:
        java.lang.Exception - It is thrown when an error occurs.