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


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

SQL Table Name: EnsLib_EDI_ASTM.Document

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

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DEFSEARCHCLASS = EnsLib.EDI.ASTM.SearchTable;
Name of the default SearchTable indexing class used in UI choices and MessageBank submissions
Inherited description: Full descriptive name for this subclass of document
parameter DOCCLASSNAME = ASTM Document;
Inherited description: Compact descriptive name for this subclass of document
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.ASTM.Schema:DS;
Name of the associated schema class and, after a colon, the schema class code that represents a DocType

Properties (Including Private)

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 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 ];
Stored raw document type name ; the secondary type name portion of the DocType
Property methods: DocTypeNameDisplayToLogical(), DocTypeNameGet(), DocTypeNameIsValid(), DocTypeNameLogicalToDisplay(), DocTypeNameLogicalToOdbc(), DocTypeNameNormalize()
property Envelope as %String);
'Envelope' information for the ASTM document message. Used in propagating info about the return Service address for reply documents
Property methods: EnvelopeDisplayToLogical(), EnvelopeGet(), EnvelopeGetStored(), EnvelopeIsValid(), EnvelopeLogicalToDisplay(), EnvelopeLogicalToOdbc(), EnvelopeNormalize(), EnvelopeSet()
property EscapeSeparator as %String [ Calculated , Transient ];
Escape separator character
Property methods: EscapeSeparatorDisplayToLogical(), EscapeSeparatorGet(), EscapeSeparatorIsValid(), EscapeSeparatorLogicalToDisplay(), EscapeSeparatorLogicalToOdbc(), EscapeSeparatorNormalize()
property FieldSeparator as %String [ Calculated , Transient ];
Data-field separator character
Property methods: FieldSeparatorDisplayToLogical(), FieldSeparatorGet(), FieldSeparatorIsValid(), FieldSeparatorLogicalToDisplay(), FieldSeparatorLogicalToOdbc(), FieldSeparatorNormalize()
property FullSize as %Integer [ Calculated , Transient , ReadOnly ];
Size in bytes of the message content (assuming 1-byte segment terminators, including segments >32k)
Property methods: FullSizeDisplayToLogical(), FullSizeGet(), FullSizeIsValid(), FullSizeLogicalToDisplay(), FullSizeNormalize()
property Identifier as %String [ Calculated , Transient , ReadOnly ];
Unique document identification string found in document content
Property methods: IdentifierCompute(), IdentifierDisplayToLogical(), IdentifierGet(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogica