Click or drag to resize

ESDocument Class

Ecommerce Standards Document that contains the base set of properties for all documents
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    More...

Namespace:  EcommerceStandardsDocuments
Assembly:  EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.3.0.0 (1.0.0.0)

The ESDocument type exposes the following members.

Constructors
  NameDescription
Public methodESDocument
Constructor that sets that initialises the document's properties
Public methodESDocument(Int32, String)
Constructor
Top
Fields
  NameDescription
Public fieldconfigs
A dictionary of additional configurations and settings to include with each Ecommerce Standard Document. Typically documents would contain the "dataFields" key that would have a comma delimited list of record properties that are expected to contain data when reading the document's records. Any records not containing data for properties in list could then have the data set to a default when saved to a database.
Public fielddataTransferMode
Denotes if the data being placed into document is a complete data set, or partial data being transferred containing only data changes.
Public fieldmessage
Message providing details of if the data could be obtained when requesting the document. The message gives meaning to the result status.
Public fieldresultStatus
Code that denotes if the data could be successfully obtained for the document, and if not why. See ESDocumentConstants Class for the list of status codes
Public fieldtotalDataRecords
The total number of records placed within document. For documents that contain multiple record lists, please check the relevant documentation to see how this number applies.
Public fieldversion
Version of the Ecommerce Standards Document. Verifying the version of the document is critical for systems transferring and manipulating the data.
Top
See Also
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    EcommerceStandardsDocumentsESDocumentAlternateCode
    EcommerceStandardsDocumentsESDocumentAttachment
    EcommerceStandardsDocumentsESDocumentAttribute
    EcommerceStandardsDocumentsESDocumentCategory
    EcommerceStandardsDocumentsESDocumentCurrencyExchangeRate
    EcommerceStandardsDocumentsESDocumentCustomerAccount
    EcommerceStandardsDocumentsESDocumentCustomerAccountAddress
    EcommerceStandardsDocumentsESDocumentCustomerAccountContract
    EcommerceStandardsDocumentsESDocumentCustomerAccountEnquiry
    EcommerceStandardsDocumentsESDocumentCustomerAccountEnquiryLine
    EcommerceStandardsDocumentsESDocumentCustomerAccountEnquiryProductPrice
    EcommerceStandardsDocumentsESDocumentCustomerAccountPayment
    EcommerceStandardsDocumentsESDocumentCustomerInvoice
    EcommerceStandardsDocumentsESDocumentDeliveryNotice
    EcommerceStandardsDocumentsESDocumentDownload
    EcommerceStandardsDocumentsESDocumentFlag
    EcommerceStandardsDocumentsESDocumentGeneralLedgerAccount
    EcommerceStandardsDocumentsESDocumentImage
    EcommerceStandardsDocumentsESDocumentItemGroup
    EcommerceStandardsDocumentsESDocumentItemRelation
    EcommerceStandardsDocumentsESDocumentKit
    EcommerceStandardsDocumentsESDocumentLabour
    EcommerceStandardsDocumentsESDocumentLocation
    EcommerceStandardsDocumentsESDocumentMaker
    EcommerceStandardsDocumentsESDocumentMakerModel
    EcommerceStandardsDocumentsESDocumentMakerModelMapping
    EcommerceStandardsDocumentsESDocumentOrderPurchase
    EcommerceStandardsDocumentsESDocumentOrderSale
    EcommerceStandardsDocumentsESDocumentPaymentType
    EcommerceStandardsDocumentsESDocumentPrice
    EcommerceStandardsDocumentsESDocumentPriceLevel
    EcommerceStandardsDocumentsESDocumentProduct
    EcommerceStandardsDocumentsESDocumentProductCombination
    EcommerceStandardsDocumentsESDocumentPurchaser
    EcommerceStandardsDocumentsESDocumentSalesRep
    EcommerceStandardsDocumentsESDocumentSellUnit
    EcommerceStandardsDocumentsESDocumentStockQuantity
    EcommerceStandardsDocumentsESDocumentSupplierAccount
    EcommerceStandardsDocumentsESDocumentSupplierAccountAddress
    EcommerceStandardsDocumentsESDocumentSupplierAccountEnquiry
    EcommerceStandardsDocumentsESDocumentSupplierInvoice
    EcommerceStandardsDocumentsESDocumentSurcharge
    EcommerceStandardsDocumentsESDocumentTaxcode