Why do we use getExtensionData()

Question

Can anybody tell me what we are doing here...
String totalDueStr = (String)headersalesdocument.getExtensionData("ZZTOTAL_DUE");
Why do we use getExtensionData().

Answer 1

Headersalesdocument
    Class:        HeaderSalesDocument
    Copyright (c) 2001, SAP AG, All rights reserved.
    Author:       SAP AG
    Created:      11.4.2001
    Version:      1.0
    $Revision: #12 $
    $Date: 2003/01/02 $
package com.sapmarkets.isa.businessobject.header;
import java.util.ArrayList;
import java.util.List;
import com.sapmarkets.isa.backend.boi.isacore.ConnectedDocumentData;
import com.sapmarkets.isa.backend.boi.isacore.ShipToData;
import com.sapmarkets.isa.backend.boi.isacore.ShopData;
import com.sapmarkets.isa.backend.boi.isacore.order.HeaderData;
import com.sapmarkets.isa.backend.boi.isacore.order.PartnerListData;
import com.sapmarkets.isa.backend.boi.isacore.order.PaymentData;
import com.sapmarkets.isa.backend.boi.isacore.order.PaymentTypeData;
import com.sapmarkets.isa.backend.boi.isacore.order.TextData;
import com.sapmarkets.isa.businessobject.BusinessObjectBase;
import com.sapmarkets.isa.businessobject.ConnectedDocument;
import com.sapmarkets.isa.businessobject.ShipTo;
import com.sapmarkets.isa.businessobject.Shop;
import com.sapmarkets.isa.businessobject.order.PartnerList;
import com.sapmarkets.isa.businessobject.order.PartnerListEntry;
import com.sapmarkets.isa.businessobject.order.Payment;
import com.sapmarkets.isa.businessobject.order.PaymentType;
import com.sapmarkets.isa.businessobject.order.Text;
import com.sapmarkets.isa.core.TechKey;
Common Header Information for all objects of the bo layer that are considered
to be sales documents.
@author SAP AG
@version 1.0
public class HeaderSalesDocument extends BusinessObjectBase
        implements HeaderData, Cloneable {
Constant defining a document that is in the completion status OPEN.
    public static final String DOCUMENT_COMPLETION_STATUS_OPEN      = "open";
Constant defining a document that is in the completion status COMPLETED.
    public static final String DOCUMENT_COMPLETION_STATUS_COMPLETED = "completed";
Constant defining a document that is in the completion status PARTLY_DELIVERED.
    public static final String DOCUMENT_COMPLETION_STATUS_PARTLY_DELIVERED = "partlydelivered";
Constant defining a document that is in the completion status CANCELLED.
    public static final String DOCUMENT_COMPLETION_STATUS_CANCELLED = "cancelled";
Constant defining a document that is in the completion status INPROCESS.
    public static final String DOCUMENT_COMPLETION_STATUS_INPROCESS = "inprocess";
Constant defining a document that is in the completion status ACCEPTED.
    public static final String DOCUMENT_COMPLETION_STATUS_ACCEPTED = "accepted";
Constant defining a document that is in the completion status RELEASED.
    public static final String DOCUMENT_COMPLETION_STATUS_RELEASED = "released";
Constant defining a document that is in the completion status INQUIRYSENT.
    public static final String DOCUMENT_COMPLETION_STATUS_INQUIRYSENT = "inquirysent";
Constant defining a document that is in the completion status QUOTATION.
    public static final String DOCUMENT_COMPLETION_STATUS_QUOTATION = "quotation";
Constant defining a document that is in the completion status REJECTED.
    public static final String DOCUMENT_COMPLETION_STATUS_REJECTED = "rejected";
Constant defining a document that is in the completion status READY TO
PICKUP
     public static final String DOCUMENT_COMPLETION_STATUS_READY_TO_PICKUP = "readytopick";
    private boolean changeable;        // Document changeable in general (R/3 documents are not changeable yet)
    private String changedAt;
    private String createdAt;
    private String currency;
    private String description;
    private String division;
    private String disChannel;
    protected String documentType;
    private String freightValue;
    private String grossValue;
    private String netValue;
     private String netValueWOFreight;   
    protected PartnerList partnerList = new PartnerList();
    private String processType;
    private String processTypeDesc;
    private String salesDocNumber;
    private String purchaseOrderExt;
    private String postingDate;
    private String salesDocumentsOrigin;
    private String salesOrg;
    private String salesOffice;
    private String reqDeliveryDate;
    private Shop shop;
    private String shipCond;
    private String status;
    private String taxValue;
    private Text text;
    private Text textHistory;
    private String validTo;
    private ShipTo shipTo;
    private boolean purchaseOrderChangeable;
    private boolean purchaseOrderExtChangeable;
    private boolean quotationExtended;
    private boolean salesOrgChangeable;
    private boolean salesOfficeChangeable;
    private boolean reqDeliveryDateChangeable;
    private boolean shipCondChangeable;
    private boolean descriptionChangeable;
    private String ipcHost;
    private String ipcPort;
    private String ipcSession;
    private String ipcClient;
    private TechKey ipcDocumentId;
    private Payment payment;
    private String statusDelivery;
    private ArrayList predecessorList = new ArrayList();
    private ArrayList successorList = new ArrayList();
    protected boolean isDirty = false; // must header be read from backend ?
Drops the state of the object. All reference fields, except partnerList, are
set to null, all primitive types are set to the default values they would have
after the creation of a new instance. Use this method to reset the state to the
state a newly created object would have. The advantage is, that the
overhead caused by the normal object creation is omitted.
    public void clear() {
        changedAt                   = null;
        createdAt                   = null;
        currency                    = null;
        description                 = null;
        division                    = null;
        disChannel                  = null;
        documentType                = null;
        freightValue                = null;
        grossValue                  = null;
        netValue                    = null;
        partnerList.clearList();
        processType                 = null;
        salesDocNumber              = null;
        purchaseOrderExt            = null;
        postingDate                 = null;
        salesDocumentsOrigin        = null;
        salesOrg                    = null;
        salesOffice                 = null;
        reqDeliveryDate             = null;
        shop                        = null;
        shipCond                    = null;
        status                      = null;
        statusDelivery              = null;
        taxValue                    = null;
        text                        = null;
//        techKey                     = null;
        validTo                     = null;
        shipTo                      = null;
        ipcHost                     = null;
        ipcPort                     = null;
        ipcSession                  = null;
        ipcClient                   = null;
        ipcDocumentId               = null;
        payment                     = null;
        purchaseOrderChangeable     = false;
        purchaseOrderExtChangeable  = false;
        quotationExtended           = false;
        salesOrgChangeable          = false;
        salesOfficeChangeable       = false;
        reqDeliveryDateChangeable   = false;
        shipCondChangeable          = false;
        descriptionChangeable       = false;
        changeable                  = false;
        removeExtensionDataValues();
        predecessorList.clear();
        successorList.clear();
        isDirty = true;
Creates a new <code>Text</code> object casted to the backend enabled
<code>TextData</code> interface. This method is normally only used
by backend implementations as a factory method to get instances of
business objects.
@return a newly created <code>Text</code> object
    public TextData createText() {
        return (TextData) new Text();
Get the host the IPC runs on.
@return hostname of the host the IPC runs on
    public String getIpcHost() {
        return ipcHost;
Sets the host the IPC runs on.
@param ipcHost the hostname of the ipc host
    public void setIpcHost(String ipcHost) {
        this.ipcHost = ipcHost;
Get an identifier for the current IPC session.
@return identifier for the current IPC session
    public String getIpcSession() {
        return ipcSession;
Sets the identifier for the current IPC session.
@param ipcSession the identifier for the current IPC session to be set
    public void setIpcSession(String ipcSession) {
        this.ipcSession = ipcSession;
Get the port number of the IPC server.
@return the port number of the IPC server
     public String getIpcPort() {
        return ipcPort;
Set the port number of the ipc server.
@param ipcPort the port number of the IPC server to be set
    public void setIpcPort(String ipcPort) {
        this.ipcPort = ipcPort;
Get the IPC client.
@return the IPC client
     public String getIpcClient() {
        return ipcClient;
Set the IPC client.
@param ipcClient the IPC client to be set
    public void setIpcClient(String ipcClient) {
        this.ipcClient = ipcClient;
Get the IPC document id.
@return the IPC document id
    public TechKey getIpcDocumentId() {
        return ipcDocumentId;
Set the IPC document id.
@param ipcDocumentId the IPC document id to be set
    public void setIpcDocumentId(TechKey ipcDocumentId) {
        this.ipcDocumentId = ipcDocumentId;
Get the requested delivery date.
@return the requestet delivery date
    public String getReqDeliveryDate() {
        return reqDeliveryDate;
Set the requested delivery date.
@param reqDeliveryDate the requested delivery date to be set.
    public void setReqDeliveryDate(String reqDeliveryDate) {
        this.reqDeliveryDate = reqDeliveryDate;
Get the business partner list
@return PartnerList list of business partners
    public PartnerList getPartnerList() {
        return partnerList;
Set the business partner list
@param PartnerList new list of business partners
    public void setPartnerList(PartnerList partnerList) {
        this.partnerList = partnerList;
Get the business partner list
@return PartnerListData list of business partners
    public PartnerListData getPartnerListData() {
        return partnerList;
Sets the business partner list.
@param list list of business partners
    public void setPartnerListData(PartnerListData list) {
        partnerList = (PartnerList) list;
Get the date, the document was changed the last time.
@return the date, the document was changed the last time
    public String getChangedAt() {
        return changedAt;
Set the date, the document was changed the last time.
@param changedAt the date, the document was changed the last time
    public void setChangedAt(String changedAt){
        this.changedAt = changedAt;
Get the date, the document was created.
@return date, the document was created
    public String getCreatedAt() {
        return createdAt;
Set the date, the document was cerated.
@param createdAt the date, the document was cerated
    public void setCreatedAt(String createdAt){
        this.createdAt = createdAt;
Get the currency used for this document.
@return the currency used for this document
    public String getCurrency(){
        return currency;
Set the currency used for this document.
@param currency the currency used for this document
    public void setCurrency(String currency){
        this.currency = currency;
Get description added on the header level.
@return description
    public String getDescription(){
        return description;
Sets the description on the header level.
@param description the description
    public void setDescription(String description){
        this.description = description;
Get the devision.
@return the devision
    public String getDivision(){
        return division;
Set the devision.
@param devision the devision to be set
    public void setDivision(String division){
        this.division = division;
Get the distribution channel.
@return distribution channel
    public String getDisChannel(){
        return disChannel;
Set the distribution channel.
@param disChannel the distribution channel to be set
    public void setDisChannel(String disChannel){
        this.disChannel = disChannel;
Get the price for the freigth of the order.
@return the price for the freight of the
    public String getFreightValue(){
        return freightValue;
Set the price for the freight of the order.
@param freightValue the price for the freight
    public void setFreightValue(String freightValue){
        this.freightValue = freightValue;
Get the price including all taxes but not the freight.
@return the value
    public String getGrossValue(){
        return grossValue;
Set the price including all taxes but not the freight.
@param grossValue the price to be set
    public void setGrossValue(String grossValue){
        this.grossValue = grossValue;
Get the net price
@return the price
    public String getNetValue(){
        return netValue;
Set the net price
@param netValue the price to be set
    public void setNetValue(String netValue){
        this.netValue = netValue;
Get the net price without freight.
@return the price
     public String getNetValueWOFreight(){
          return netValueWOFreight;
Set the net price without freight.
@param netValue the price to be set
     public void setNetValueWOFreight(String netValueWOFreight){
          this.netValueWOFreight = netValueWOFreight;
Get the process type of the document.
@return process type
    public String getProcessType(){
        return processType;
Set the process type of the document.
@param processType the process type to be set
    public void setProcessType(String processType){
        this.processType = processType;
Get the number of the sales document the header belongs to.
@return the number of the sales document
    public String getSalesDocNumber(){
        return salesDocNumber;
Set the number of the sales document the header belongs to.
@param salesDocNumber the number of the sales document
    public void setSalesDocNumber(String salesDocNumber){
        this.salesDocNumber = salesDocNumber;
Get the external pruchase order number.
@return the purchase order number
    public String getPurchaseOrderExt(){
        return purchaseOrderExt;
Set the external purchase order number.
@param purchaseOrderExt the number to be set
    public void setPurchaseOrderExt(String purchaseOrderExt){
        this.purchaseOrderExt = purchaseOrderExt;
Get the date the order was created from the customer's point of view.
@return the posting date
    public String getPostingDate(){
        return postingDate;
Set the date the order was created from the customer's point of view.
@param postingData the date to be set
    public void setPostingDate(String postingDate){
        this.postingDate = postingDate;
Get the sales organization for the document.
@return the sales organization
    public String getSalesOrg(){
        return salesOrg;
Set the sales organization for the document.
@param salesOrg the sales organization.
    public void setSalesOrg(String salesOrg){
        this.salesOrg = salesOrg;
Get the sales office.
@return the sales office
    public String getSalesOffice(){
        return salesOffice;
Set the sales office.
@param salesOffice the sales office
    public void setSalesOffice(String salesOffice){
        this.salesOffice = salesOffice;
Get the shop the document belongs to.
@return the shop
    public ShopData getShop(){
        return (ShopData)shop;
Set the shop the document belongs to.
@param shop the shop to be set
    public void setShop(ShopData shop){
        this.shop = (Shop)shop;
Get the shipping conditions for the document.
@return the shipping conditions
    public String getShipCond(){
        return shipCond;
Set the shipping conditions for the document.
@param shipCond the shipping conditions
    public void setShipCond(String shipCond){
        this.shipCond = shipCond;
Get the taxes that have to be paid for the document.
@return the taxes
    public String getTaxValue(){
        return taxValue;
Set the taxes that have to be paid for the document.
@param taxValue the taxes to be set
    public void setTaxValue(String taxValue){
        this.taxValue = taxValue;
Get text on the header level of the document.
@return the text
    public TextData getText() {
        return text;
Set the text on the header level of the document.
@param text the text to be set
    public void setText(TextData text) {
        this.text = (Text) text;
Get text history on the header level of the document.
@return the text history
    public TextData getTextHistory() {
        return textHistory;
Set the text history on the header level of the document.
@param text the text history to be set
    public void setTextHistory(TextData text) {
        this.textHistory = (Text) text;
Get the date, the document is valid to.
@return the date
    public String getValidTo(){
        return validTo;
Set the date, the document is valid to.
@param validTo the date to be set
    public void setValidTo(String validTo){
        this.validTo = validTo;
Check whether or not the document is changeable.
@return <code>true</code> if the document is changeable,
        otherwise <code>false</code>.
    public boolean isChangeable(){
        return changeable;
Set whether or not the document is changeable using a String parameter.
@param changeable <code>" "</code> or <code>""</code> indicates that the
                  document is changeable, all other values that it is
                  changeable.
    public void setChangeable(String changeable){
        if (changeable.equals("") || changeable.equals(" ")) {
            this.changeable = false;
        } else {
            this.changeable = true;
Set whether or not the document is changeable.
@param changeable <code>true</code> indicates that the document is changeable,
                  <code>false</code> indicates that it is not.
    public void setChangeable(boolean changeable){
        this.changeable = changeable;
Sets all changeable flags for the different fields of the header in
on step.
@param purchaseOrderChangeable <code>true</code> indicates that the
       purchase order information is changeable
@param purchaseOrderExtChangeable <code>true</code> indicates that the
       external purchase order information is changeable
@param salesOrgChangeable <code>true</code> indicates that the
       sales organization information is changeable
@param salesOfficeChangeable <code>true</code> indicates that the
       sales office information is changeable
@param reqDeliveryDateChangeable <code>true</code> indicates that the
       requested delivery date is changeable
@param shipCondChangeable <code>true</code> indicates that the
       shipping conditions are changeable
@param descriptionChangeable <code>true</code> indicates that the
       description is changeable
    public void setAllValuesChangeable(
             boolean purchaseOrderChangeable,
             boolean purchaseOrderExtChangeable,
             boolean salesOrgChangeable,
             boolean salesOfficeChangeable,
             boolean reqDeliveryDateChangeable,
             boolean shipCondChangeable,
             boolean descriptionChangeable) {
        this.purchaseOrderChangeable     = purchaseOrderChangeable;
        this.purchaseOrderExtChangeable  = purchaseOrderExtChangeable;
        this.salesOrgChangeable          = salesOrgChangeable;
        this.salesOfficeChangeable       = salesOfficeChangeable;
        this.reqDeliveryDateChangeable   = reqDeliveryDateChangeable;
        this.shipCondChangeable          = shipCondChangeable;
        this.descriptionChangeable       = descriptionChangeable;
Checks whether or not the purchase order information is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isPurchaseOrderChangeable() {
        return purchaseOrderChangeable;
Checks whether or not the external purchase order information is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isPurchaseOrderExtChangeable() {
        return purchaseOrderExtChangeable;
Checks whether or not the sales organisation is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isSalesOrgChangeable() {
        return salesOrgChangeable;
Checks whether or not the sales office is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isSalesOfficeChangeable() {
        return salesOfficeChangeable;
Checks whether or not the requested delivery date is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isReqDeliveryDateChangeable() {
        return reqDeliveryDateChangeable;
Checks whether or not the description is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isDescriptionChangeable() {
        return descriptionChangeable;
Checks whether or not the shipping condition is changeable.
@return <code>true</code> indicates that the information is changeable,
        <code>false</code> indicates that the information cannot be changed.
    public boolean isShipCondChangeable() {
        return shipCondChangeable;
Get the origin of the sales document.
@return the origin of the sales document
    public String getSalesDocumentsOrigin(){
        return salesDocumentsOrigin;
Set the origin of the sales document.
@param salesDocOrigin the origin to be set
    public void setSalesDocumentsOrigin(String salesDocOrigin){
        this.salesDocumentsOrigin = salesDocOrigin;
Set the dirty flag
@param isDirty must the header be read from the backend true/false
    public void setDirty(boolean isDirty){
        this.isDirty = isDirty;
get the dirty flag
@return isDirty must the header be read from the backend true/false
    public boolean isDirty(){
        return isDirty;
Get OVERALL status. Might be different from DELIVERY status.
@return one of the possible status values represented by the constants
        defined in this class with the names <code>DOCUMENT_COMPLETION_*</code>.
    public String getStatus() {
        return status;
Set OVERALL status to open
    public void setStatusOpen() {
        status = DOCUMENT_COMPLETION_STATUS_OPEN;
Set the status to whatever passed through
    public void setStatusOther(String status) {
        this.status = status;
Determines whether or not, the document's status is OPEN.
@return <code>true</code> if the object is in status OPEN, otherwise
        <code>false</code>.
    public boolean isStatusOpen() {
        return (status == DOCUMENT_COMPLETION_STATUS_OPEN);