Package de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.interf

Interface HeaderBase

    • Field Detail

      • DOCUMENT_COMPLETION_STATUS_OPEN

        static final java.lang.String DOCUMENT_COMPLETION_STATUS_OPEN
        Constant defining a document that is in the completion status OPEN.
        See Also:
        Constant Field Values

      • DOCUMENT_COMPLETION_STATUS_INPROCESS

        static final java.lang.String DOCUMENT_COMPLETION_STATUS_INPROCESS
        Constant defining a document that is in the completion status INPROCESS.
        See Also:
        Constant Field Values

      • DOCUMENT_COMPLETION_STATUS_COMPLETED

        static final java.lang.String DOCUMENT_COMPLETION_STATUS_COMPLETED
        Constant defining a document that is in the completion status COMPLETED.
        See Also:
        Constant Field Values

    • Method Detail

      • addPredecessor

        void addPredecessor​(ConnectedDocument predecessorData)
        Adds a ConnectedDocument to the predecessor list. A null reference passed to this function will be ignored, in this case nothing will happen.
        Parameters:
        predecessorData - ConnectedDocument to be added to the predecessor list

      • addSuccessor

        void addSuccessor​(ConnectedDocument successorData)
        Adds a ConnectedDocument to the successor list. A null reference passed to this function will be ignored, in this case nothing will happen.
        Parameters:
        successorData - ConnectedDocument to be added to the successor list

      • clone

        java.lang.Object clone()
        Instead of a shallow-copy this returns a deep-copy of this HeaderBaseImpl instance.
        Returns:
        a deep-copy of this HeaderBase

      • createText

        Text createText()
        Creates a text object. This method is used by back end objects to get instances of the text object.
        Returns:
        newly created text object

      • createConnectedDocument

        ConnectedDocument createConnectedDocument()
        create a ConnectedDocument object.
        Returns:
        new ConnectedDocument Instance

      • getChangedAt

        java.util.Date getChangedAt()
        Get the date, the document was changed the last time.
        Returns:
        the date, the document was changed the last time

      • getCreatedAt

        java.util.Date getCreatedAt()
        Get the date, the document was created.
        Returns:
        date, the document was created

      • getCurrency

        java.lang.String getCurrency()
        Get the currency used for this document.
        Returns:
        the currency used for this document

      • getDeliveryPriority

        java.lang.String getDeliveryPriority()
        Returns the delivery priority key
        Returns:
        String

      • getDisChannel

        java.lang.String getDisChannel()
        Get the distribution channel.
        Returns:
        distribution channel

      • getDivision

        java.lang.String getDivision()
        Get the devision.
        Returns:
        the devision

      • getDocumentType

        DocumentType getDocumentType()
        Returns the type of the document, the header belongs to.
        Returns:
        the document type.

      • getFreightValue

        java.math.BigDecimal getFreightValue()
        Get the price for the freight of the order.
        Returns:
        the price for the freight of the

      • getGrossValue

        java.math.BigDecimal getGrossValue()
        Get the price including all taxes but not the freight.
        Returns:
        the value

      • getNetValue

        java.math.BigDecimal getNetValue()
        Get the net price
        Returns:
        the price

      • getNetValueWOFreight

        java.math.BigDecimal getNetValueWOFreight()
        Get the net price without freight.
        Returns:
        the price

      • getPartnerId

        java.lang.String getPartnerId​(java.lang.String partnerFunction)
        Returns the partner id for the given partner function.
        Parameters:
        partnerFunction - partnerFucntion to be checked
        Returns:
        partner id

      • getPartnerKey

        TechKey getPartnerKey​(java.lang.String partnerFunction)
        Returns the partner key for the given partner function.
        Parameters:
        partnerFunction - partnerFucntion to be checked
        Returns:
        partner GUID

      • getPartnerList

        PartnerList getPartnerList()
        Get the business partner list
        Returns:
        PartnerList list of business partners

      • getPostingDate

        java.util.Date getPostingDate()
        Get the date the order was created from the customer's point of view.
        Returns:
        the posting date

      • getPredecessorList

        java.util.List<ConnectedDocument> getPredecessorList()
        Get the predecessor list
        Returns:
        list of all predecessor documents

      • getProcessType

        java.lang.String getProcessType()
        Get the process type of the document.
        Returns:
        process type

      • getProcessTypeDesc

        java.lang.String getProcessTypeDesc()
        Get the description of the process type
        Returns:
        description of the process type

      • getPurchaseOrderExt

        java.lang.String getPurchaseOrderExt()
        Get the external purchase order number.
        Returns:
        the purchase order number

      • getReqDeliveryDate

        java.util.Date getReqDeliveryDate()
        Get the requested delivery date.
        Returns:
        the request delivery date

      • getSalesDocNumber

        java.lang.String getSalesDocNumber()
        Get the number of the sales document the header belongs to.
        Returns:
        the number of the sales document

      • getSalesDocumentsOrigin

        java.lang.String getSalesDocumentsOrigin()
        Get the origin of the sales document.
        Returns:
        the origin of the sales document

      • getSalesOffice

        java.lang.String getSalesOffice()
        Get the sales office.
        Returns:
        the sales office

      • getSalesOrg

        java.lang.String getSalesOrg()
        Get the sales organization for the document.
        Returns:
        the sales organization

      • getShipCond

        java.lang.String getShipCond()
        Get the shipping conditions for the document.
        Returns:
        the shipping conditions

      • getSuccessorList

        java.util.List<ConnectedDocument> getSuccessorList()
        Get the successor list
        Returns:
        list of all successor documents

      • getTaxValue

        java.math.BigDecimal getTaxValue()
        Get the taxes that have to be paid for the document.
        Returns:
        the taxes

      • getTotalDiscount

        java.math.BigDecimal getTotalDiscount()
        Returns:
        total discount, which is used for strike through prices

      • getValidFrom

        java.util.Date getValidFrom()
        Get the date, the document is valid from.
        Returns:
        date, the document is valid from

      • getValidTo

        java.util.Date getValidTo()
        Get the date, the document is valid to.
        Returns:
        date, the document is valid to

      • isChangeable

        boolean isChangeable()
        Check whether or not the document is changeable.
        Returns:
        true if the document is changeable, otherwise false.

      • setChangeable

        void setChangeable​(boolean changeable)
        Set whether or not the document is changeable using a String parameter.
        Parameters:
        changeable - " " or "" indicates that the document is changeable, all other values that it is changeable.

      • setChangedAt

        void setChangedAt​(java.util.Date changedAt)
        Set the date, the document was changed the last time.
        Parameters:
        changedAt - the date, the document was changed the last time

      • setCreatedAt

        void setCreatedAt​(java.util.Date createdAt)
        Set the date, document was created.
        Parameters:
        createdAt - the date to be set

      • setCurrency

        void setCurrency​(java.lang.String currency)
        Set the currency used for the document the header belongs to.
        Parameters:
        currency - the currency to be set

      • setDeliveryPriority

        void setDeliveryPriority​(java.lang.String deliveryPriority)
        Sets the delivery priority key.
        Parameters:
        deliveryPriority - key

      • setDisChannel

        void setDisChannel​(java.lang.String disChannel)
        Set the distribution channel.
        Parameters:
        disChannel - the distribution channel to be set

      • setDivision

        void setDivision​(java.lang.String division)
        Set the devision.
        Parameters:
        division - the devision to be set

      • setDocumentType

        void setDocumentType​(DocumentType docType)
        Set the document type.
        Parameters:
        docType - document type

      • setFreightValue

        void setFreightValue​(java.math.BigDecimal freightValue)
        Set the price for the freight of the order.
        Parameters:
        freightValue - the price for the freight

      • setGrossValue

        void setGrossValue​(java.math.BigDecimal grossValue)
        Set the price including all taxes but not the freight.
        Parameters:
        grossValue - the price to be set

      • setNetValue

        void setNetValue​(java.math.BigDecimal netValue)
        Set the net price
        Parameters:
        netValue - the price to be set

      • setNetValueWOFreight

        void setNetValueWOFreight​(java.math.BigDecimal netValueWOFreight)
        Set the net price without freight.
        Parameters:
        netValueWOFreight - the price to be set

      • setPartnerList

        void setPartnerList​(PartnerList list)
        Sets the business partner list.
        Parameters:
        list - list of business partners

      • setPostingDate

        void setPostingDate​(java.util.Date postingDate)
        Set the date the order was created from the customer's point of view.
        Parameters:
        postingDate - the date to be set

      • setProcessType

        void setProcessType​(java.lang.String processType)
        Set the the process type of the document.
        Parameters:
        processType - the process type to be set

      • setProcessTypeDesc

        void setProcessTypeDesc​(java.lang.String processTypeDesc)
        Sets the description of the process type
        Parameters:
        processTypeDesc - The processTypeDesc to set

      • setPurchaseOrderExt

        void setPurchaseOrderExt​(java.lang.String purchaseOrderExt)
        Set the external purchase order number.
        Parameters:
        purchaseOrderExt - the number to be set

      • setReqDeliveryDate

        void setReqDeliveryDate​(java.util.Date reqDeliveryDate)
        Set the requested delivery date.
        Parameters:
        reqDeliveryDate - the requested delivery date to be set.

      • setSalesDocNumber

        void setSalesDocNumber​(java.lang.String salesDocNumber)
        Set the number of the sales document the header belongs to.
        Parameters:
        salesDocNumber - the number of the sales document

      • setSalesDocumentsOrigin

        void setSalesDocumentsOrigin​(java.lang.String salesDocOrigin)
        Set the origin of the sales document.
        Parameters:
        salesDocOrigin - the origin to be set

      • setSalesOffice

        void setSalesOffice​(java.lang.String salesOffice)
        Set the sales office.
        Parameters:
        salesOffice - the sales office

      • setSalesOrg

        void setSalesOrg​(java.lang.String salesOrg)
        Set the sales organization for the document.
        Parameters:
        salesOrg - the sales organization.

      • setShipCond

        void setShipCond​(java.lang.String shipCond)
        Set the shipping conditions for the document.
        Parameters:
        shipCond - the shipping conditions

      • setTaxValue

        void setTaxValue​(java.math.BigDecimal taxValue)
        Set the taxes that have to be paid for the document.
        Parameters:
        taxValue - the taxes to be set

      • setTotalDiscount

        void setTotalDiscount​(java.math.BigDecimal totalDiscount)
        sets the total discount, which is used for strike through prices
        Parameters:
        totalDiscount - totalDiscount as BigDecimal

      • getGrossValueWOFreight

        java.math.BigDecimal getGrossValueWOFreight()
        Get the gross price without freight.
        Returns:
        the gross price without freight

      • setGrossValueWOFreight

        void setGrossValueWOFreight​(java.math.BigDecimal grossValueWOFreight)
        Set the gross value without freight.
        Parameters:
        grossValueWOFreight - the price to be set

      • setValidFrom

        void setValidFrom​(java.util.Date validFrom)
        Sets the date, the document is valid from.
        Parameters:
        validFrom - the validFrom date to be set.

      • setValidTo

        void setValidTo​(java.util.Date validTo)
        Sets the date, the document is valid to.
        Parameters:
        validTo - the validTo date to be set.