Interface Header

    • Field Detail

      • NO_OF_ITEMS_UNKNOWN

        static final long NO_OF_ITEMS_UNKNOWN
        Constant defining that the number of items of a document is unknown. Thus it must be determined by the size of the itemList.
        See Also:
        Constant Field Values
      • NO_DELIVERY_PRIORITY

        static final java.lang.String NO_DELIVERY_PRIORITY
        Constant defining that no delivery priority is selected
        See Also:
        Constant Field Values
    • Method Detail

      • getBillingStatus

        BusinessStatus getBillingStatus()
        Gets the billing status of the Document.
        Returns:
        Billing status
      • getBillTo

        BillTo getBillTo()
        Gets the Bill-To-Party of the document
        Returns:
        Bill-To-Party
      • getDeliveryStatus

        java.lang.String getDeliveryStatus()
        Get DELIVERY status. Might be different from OVERALL status.
        Returns:
        one of the possible status values represented by the constants defined in this class with the names DOCUMENT_COMPLETION_*.
      • getIncoTerms1

        java.lang.String getIncoTerms1()
        Get the incoterms1
        Returns:
        String the incoterms1
      • getIncoTerms1Desc

        java.lang.String getIncoTerms1Desc()
        Get the incoterms1 description
        Returns:
        String the incoterms1 description
      • getIncoTerms2

        java.lang.String getIncoTerms2()
        Get the incoterms2.
        Returns:
        String the incoterms2.
      • getIpcDocumentId

        TechKey getIpcDocumentId()
        Get the IPC document id.
        Returns:
        the IPC document id
      • getOverallStatus

        OverallStatus getOverallStatus()
        get the aggregated overall status
        Returns:
        overall status
      • getPaymentTerms

        java.lang.String getPaymentTerms()
        get the payment types
        Returns:
        payment types
      • getPaymentTermsDesc

        java.lang.String getPaymentTermsDesc()
        Get the payment terms description.
        Returns:
        String the payment terms description.
      • getPricingDate

        java.util.Date getPricingDate()
        Get the pricing date
        Returns:
        the pricing date
      • getRecallDesc

        java.lang.String getRecallDesc()
        Returns the recall description
        Returns:
        the recall description
      • getRecallId

        java.lang.String getRecallId()
        Returns the recall id
        Returns:
        the recall id
      • getShippingManualPriceCondition

        java.lang.String getShippingManualPriceCondition()
        Returns shipping manual price condition
        Returns:
        shipping manual price condition
      • getShippingStatus

        BusinessStatus getShippingStatus()
        get the business status
        Returns:
        business status
      • getShipTo

        ShipTo getShipTo()
        Get the ship to information as an backend layer interface.
        Returns:
        the ship to information
      • getTotalManualPriceCondition

        java.lang.String getTotalManualPriceCondition()
        Returns total manual price condition
        Returns:
        total manual price condition
      • isDeliveryStatusCompleted

        boolean isDeliveryStatusCompleted()
        Determines whether or not, the document's delivery status is COMPLETED.
        Returns:
        true if the object is in status COMPLETED, otherwise false.
      • isDeliveryStatusInProcess

        boolean isDeliveryStatusInProcess()
        Determines whether or not, the document's delivery status is INPROCESS.
        Returns:
        true if the object is in status INPROCESS, otherwise false.
      • isDeliveryStatusOpen

        boolean isDeliveryStatusOpen()
        Determines whether or not, the document's delivery status is OPEN.
        Returns:
        true if the object is in status OPEN, otherwise false.
      • isDocumentTypeOrder

        boolean isDocumentTypeOrder()
        Determines whether or not, the document's type is ORDER.
        Returns:
        true if the type is ORDER, otherwise false.
      • setBillTo

        void setBillTo​(BillTo billTo)
        Sets the Bill-To-Party into the the document.
        Parameters:
        billTo - bill-to party
      • setDeliveryStatusCompleted

        void setDeliveryStatusCompleted()
        Set DELIVERY status to completed
      • setDeliveryStatusInProcess

        void setDeliveryStatusInProcess()
        Set DELIVERY status to in process
      • setDeliveryStatusOpen

        void setDeliveryStatusOpen()
        Set DELIVERY status to open
      • setIncoTerms1

        void setIncoTerms1​(java.lang.String incoTerms1)
        Set the incoterms1.
        Parameters:
        incoTerms1 - the incoterms1 to be set.
      • setIncoTerms1Desc

        void setIncoTerms1Desc​(java.lang.String incoTerms1Desc)
        Set the incoterms1 description
        Parameters:
        incoTerms1Desc - the incoterms1 description to be set.
      • setIncoTerms2

        void setIncoTerms2​(java.lang.String incoTerms2)
        Set the incoterms2.
        Parameters:
        incoTerms2 - the incoterms2 to be set.
      • setIpcDocumentId

        void setIpcDocumentId​(TechKey ipcDocumentId)
        Set the IPC document id.
        Parameters:
        ipcDocumentId - the IPC document id to be set
      • setPaymentTerms

        void setPaymentTerms​(java.lang.String paymentTerms)
        Set the payment terms.
        Parameters:
        paymentTerms - the payment terms to be set.
      • setPaymentTermsDesc

        void setPaymentTermsDesc​(java.lang.String paymentTermsDesc)
        Set the payment terms description
        Parameters:
        paymentTermsDesc - the payment terms description to be set.
      • setPricingDate

        void setPricingDate​(java.util.Date pricingDate)
        Set the pricing date.
        Parameters:
        pricingDate - the pricing date
      • setRecallDesc

        void setRecallDesc​(java.lang.String recallDesc)
        Sets the recall description
        Parameters:
        recallDesc - the recall description
      • setRecallId

        void setRecallId​(java.lang.String recallId)
        Sets the recall id
        Parameters:
        recallId - the recall id
      • setShippingManualPriceCondition

        void setShippingManualPriceCondition​(java.lang.String priceType)
        Sets the shipping manual price condition
        Parameters:
        priceType - new shipping manual price condition
      • setShipTo

        void setShipTo​(ShipTo shipToData)
        Sets the default ship to for the header. This ship to is used, if no special information is set at the item level.
        Parameters:
        shipToData - The ship to, to be set
      • setTotalManualPriceCondition

        void setTotalManualPriceCondition​(java.lang.String priceType)
        Sets the total manual price condition
        Parameters:
        priceType - manual price conidtion
      • getPaymentDeduction

        java.math.BigDecimal getPaymentDeduction()
        Return the value that has to be deducted of the payment amount.
        Returns:
        BigDecimal
      • setPaymentDeduction

        void setPaymentDeduction​(java.math.BigDecimal value)
        Set the value that has to be deducted of the payment amount.
        Parameters:
        value - amount to be deducted
      • isDocumentTypeQuotation

        boolean isDocumentTypeQuotation()
        Determines whether or not, the document's type is QUOTATION.
        Returns:
        true if the type is QUOTATION, otherwise false.
      • isDocumentTypeRFQ

        boolean isDocumentTypeRFQ()
        Determines whether or not, the document's type is RFQ.
        Returns:
        true if the type is RFQ, otherwise false.