Home > Class Reference > ENSLIB namespace > EnsLib.EDI.EDIFACT.Document

EnsLib.EDI.EDIFACT.Document

persistent class EnsLib.EDI.EDIFACT.Document extends %Library.Persistent, EnsLib.EDI.BatchDocument, EnsLib.EDI.Segmented, EnsLib.EDI.EDIFACT.MsgBodyMethods

SQL Table Name: EnsLib_EDI_EDIFACT.Document

Represents an Interchange or a TransactionSet. FunctionalGroups are represented as Segments within an Interchange.

Property Inventory

Method Inventory

Parameters

parameter DEFSEARCHCLASS = EnsLib.EDI.EDIFACT.SearchTable;
Name of the default SearchTable indexing class used in UI choices and MessageBank submissions
parameter DOCCLASSFULLNAME = UN EDIFACT EDI Document;
Inherited description: Full descriptive name for this subclass of document
parameter DOCCLASSNAME = EDIFACT Document;
Inherited description: Compact descriptive name for this subclass of document
parameter DOCSHORTNAME = EDIFACT;
parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter EXTENTSIZE = 2000000;
Inherited description: The EXTENTSIZE parameter is used to inform the Caché SQL Query Optimizer of the approximate number of instances in the extent containing instances of this class.

For example, a class that expects to have about 1,000,000 instances should define:

parameter EXTENTSIZE = 1000000;
parameter SCHEMACLASS = EnsLib.EDI.SEF.Schema:DS:EDIFACT;
Name of the associated schema class and after a colon the schema element code that represents a DocType

Properties

property %maps [ MultiDimensional , Transient ];
A local array of orefs "orefs" - a local map of integer ids to segment objects And either a subscript into ^CacheTemp for this object's LVD maps (for notes on LVD implementation see EnsEDI.inc) or local storage for these additional maps: "runtimeIndex" - array for runtime index to segment; will always be defined unless mapRuntimePath is defined "runtimePath" - array for runtime path to segment "bidirectionalLink" - array for runtime path and index linkage
Property methods: %mapsDisplayToLogical(), %mapsGet(), %mapsIsValid(), %mapsLogicalToDisplay(), %mapsLogicalToOdbc(), %mapsNormalize(), %mapsSet()
property Attachments as array of Ens.StreamContainer;
Attachment streams associated with this document
Property methods: AttachmentsBuildValueArray(), AttachmentsCollectionToDisplay(), AttachmentsCollectionToOdbc(), AttachmentsDisplayToCollection(), AttachmentsGet(), AttachmentsGetObject(), AttachmentsGetObjectId(), AttachmentsGetStored(), AttachmentsGetSwizzled(), AttachmentsIsValid(), AttachmentsOdbcToCollection(), AttachmentsSet(), AttachmentsSetObject(), AttachmentsSetObjectId()
property ChildCount as %Integer [ Calculated , Transient , ReadOnly ];
Number of Children
Property methods: ChildCountCompute(), ChildCountDisplayToLogical(), ChildCountGet(), ChildCountIsValid(), ChildCountLogicalToDisplay(), ChildCountNormalize(), ChildCountSQLCompute()
property ComponentSeparator as %String [ Calculated , Transient ];
Sub-element component separator character
Property methods: ComponentSeparatorDisplayToLogical(), ComponentSeparatorGet(), ComponentSeparatorIsValid(), ComponentSeparatorLogicalToDisplay(), ComponentSeparatorLogicalToOdbc(), ComponentSeparatorNormalize()
property DocTypeCategory as %String [ Transient , ReadOnly ];
the category portion of the DocType
Property methods: DocTypeCategoryDisplayToLogical(), DocTypeCategoryGet(), DocTypeCategoryIsValid(), DocTypeCategoryLogicalToDisplay(), DocTypeCategoryLogicalToOdbc(), DocTypeCategoryNormalize(), DocTypeCategorySet()
property DocTypeName as %String [ Transient , ReadOnly ];