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

Interface HeaderBase

All Superinterfaces:
BusinessObject, Cloneable, MessageListHolder, Serializable, SimpleHeader
All Known Subinterfaces:
Header
All Known Implementing Classes:
HeaderBaseImpl, HeaderSalesDocument
public interface HeaderBase extends SimpleHeader
Represents the backend's view of the header of a sales document.
Version:
1.0

  • Field Details

    • DOCUMENT_COMPLETION_STATUS_OPEN

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

    • DOCUMENT_COMPLETION_STATUS_INPROCESS

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

    • DOCUMENT_COMPLETION_STATUS_COMPLETED

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

  • Method Details

    • 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

      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

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

    • getCreatedAt

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

    • getCurrency

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

    • getDeliveryPriority

      String getDeliveryPriority()
      Returns the delivery priority key
      Returns:
      String

    • getDisChannel

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

    • getDivision

      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

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

    • getGrossValue

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

    • getNetValue

      BigDecimal getNetValue()
      Get the net price
      Returns:
      the price

    • getNetValueWOFreight

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

    • getPartnerId

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

    • getPartnerKey

      TechKey getPartnerKey(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

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

    • getPredecessorList

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

    • getProcessType

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

    • getProcessTypeDesc

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

    • getPurchaseOrderExt

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

    • getReqDeliveryDate

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

    • getSalesDocNumber

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

    • getSalesDocumentsOrigin

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

    • getSalesOffice

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

    • getSalesOrg

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

    • getShipCond

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

    • getSuccessorList

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

    • getTaxValue

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

    • getTotalDiscount

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

    • getValidFrom

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

    • getValidTo

      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(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(Date createdAt)
      Set the date, document was created.
      Parameters:
      createdAt - the date to be set

    • setCurrency

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

    • setDeliveryPriority

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

    • setDisChannel

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

    • setDivision

      void setDivision(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(BigDecimal freightValue)
      Set the price for the freight of the order.
      Parameters:
      freightValue - the price for the freight

    • setGrossValue

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

    • setNetValue

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

    • setNetValueWOFreight

      void setNetValueWOFreight(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(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(String processType)
      Set the the process type of the document.
      Parameters:
      processType - the process type to be set

    • setProcessTypeDesc

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

    • setPurchaseOrderExt

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

    • setReqDeliveryDate

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

    • setSalesDocNumber

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

    • setSalesDocumentsOrigin

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

    • setSalesOffice

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

    • setSalesOrg

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

    • setShipCond

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

    • setTaxValue

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

    • setTotalDiscount

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

    • getGrossValueWOFreight

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

    • setGrossValueWOFreight

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

    • setValidFrom

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

    • setValidTo

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