EnsLib.EDI.X12.Document
persistent class EnsLib.EDI.X12.Document extends %Library.Persistent, EnsLib.EDI.BatchDocument, EnsLib.EDI.Segmented, EnsLib.EDI.X12.MsgBodyMethods
SQL Table Name: EnsLib_EDI_X12.Document
Represents an Interchange or a TransactionSet. FunctionalGroups are represented as Segments within an Interchange.Property Inventory
- %maps
- Attachments
- ChildCount
- ComponentSeparator
- DocTypeCategory
- DocTypeName
- ElementSeparator
- Envelope
- FullSize
- Identifier
- Name
- ParentGE
- ParentGEId
- ParentGS
- ParentGSId
- ParentIEA
- ParentIEAId
- ParentISA
- ParentISAId
- ParentIds
- ParentInterchange
- RawContent
- RepetitionSeparator
- SegCount
- SegmentTerminator
- Separators
- TypeVersion
Method Inventory
- AddAttachment()
- AddEndSegment()
- AddFunctionalGroup()
- AddTransactionSet()
- BuildMap()
- Clear()
- ComponentSeparatorGet()
- CopyValues()
- DetermineReplyVersion()
- DocTypeSet()
- DumpMaps()
- ElementSeparatorGet()
- EnumerateDocTypesClose()
- EnumerateDocTypesExecute()
- EnumerateDocTypesFetch()
- EnumerateSegTypesClose()
- EnumerateSegTypesExecute()
- EnumerateSegTypesFetch()
- EnumerateTypeCategoriesClose()
- EnumerateTypeCategoriesExecute()
- EnumerateTypeCategoriesFetch()
- FindSegment()
- FullSizeGet()
- GetAlias()
- GetContentArray()
- GetFullSize()
- GetManagerLinks()
- GetNextGroupPath()
- GetNextIndex()
- GetSegmentIndex()
- GetSegmentPath()
- GetValueAt()
- IdentifierGet()
- ImportFromDevice()
- ImportFromFile()
- ImportFromIOStream()
- ImportFromLibraryStream()
- ImportFromString()
- KillGlobals()
- NameGet()
- New997OuterGroupSegs()
- NewControlID()
- NewDocumentReply997Segs()
- NewGroupReply997Segs()
- NewReplyDocument()
- NewReplyGroupSegs()
- NewReplyHeaderSegs()
- NewReplyTA1Seg()
- OutputHTML()
- OutputHTMLZen()
- OutputToDevice()
- OutputToFile()
- OutputToIOStream()
- OutputToLibraryStream()
- OutputToString()
- ParentGEGet()
- ParentGEIdGet()
- ParentGSGet()
- ParentGSIdGet()
- ParentIEAGet()
- ParentIEAIdGet()
- ParentISAGet()
- ParentISAIdGet()
- ParentInterchangeGet()
- ParentInterchangeGetObjectId()
- PokeDocType()
- Purge()
- RawContentGet()
- RepetitionSeparatorGet()
- SegCountGet()
- SegmentTerminatorGet()
- SetValueAt()
- SourceGet()
- TotalCount()
- TypeVersionGet()
- buildRuntimePathFromIndex()
- checkDocType()
- commitSegmentByIndex()
- commitSegmentByPath()
- convertRuntimePathToSchemaPath()
- getGEId()
- getGSId()
- getIEAId()
- getISAId()
- getId()
- getIdentifier()
- getName()
- getSegmentIdByIndex()
- getSegmentIdByPath()
- getSegsAsString()
- getTypeVersion()
- resolveChildDocType()
Parameters
For example, a class that expects to have about 1,000,000 instances should define:
Properties
Methods
pTargetPath contains the property path to the target set
pAction contains an action code: "set", etc..
pKey contains an optional key value or a set of comma-separated key values to be used as array indices where empty array index placeholders are present in pPropertyPath.
This method in implemented within the document class.
The content array is in the form:
pContents(n,"type")="%String"
pContents(n,"name")="Field"
pContents(n,"alias")=alias code
If pContents(n) is non-zero then the property is a composite type with
sub-properties. The sub-properties are indexed with a similar structure under
pContents(n,m) where m is the index of the subtype property.
pPropertyPath contains a text expression representing the address within the document of the value of interest.
pFormat contains additional context that may be used to influence the form of the result value
If no value can be found matching pPropertyPath in the current document an empty string is returned and output argument pStatus returns status information explaining the failure
This is implemented by the document subclass.
pValue contains the value to set.
pPropertyPath contains a text expression representing the address within the document of the value of interest.
pKey contains an optional key value or a set of comma-separated key values to be used as array indices where empty array index placeholders are present in pPropertyPath.
pAction contains an action code: "set", "clear", "append", etc.
If pKeepParsingAfterError is false then stop parsing when first error is encountered
Queries
The DocType is returned as the first column in the result set.
The Category parameter can be used to restrict the list.
If Category is:
0 - return only DocTypes in standard categories
+ - return only DocTypes in user-defined categories
empty - return DocTypes from all categories
a category name - return only DocTypes in the named category
a partial name suffixed with '%' - return only DocTypes in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only DocTypes defined in the current schema category itself
1 - return all DocTypes in the current schema category's base category in addition to those defined in the current category itself
The Category and Level parameters can be used to restrict the list.
If Category is:
0 - return only standard categories
+ - return only user-defined categories
empty - return all categories
a category name - return only SegTypes in the named category
a category name:segment type name - return only information about the named SegType
a partial name suffixed with '%' - return only SegTypes in categories matching the partial category name
other - return nothing
If Level is:
0 - return all segment names
n - return the given number of levels of nested field names within each segment
empty - return all levels of nested field names within each segment
If IncludeBase is:
0 - return only segment names defined in the current schema category itself
1 - return all segment names in the current schema category's base category in addition to those defined in the current category itself
The Standard parameter can be used to restrict the list.
If Standard is: 0 - return only standard categories + - return only user-defined categories empty - return all categories a partial category name - return only categories starting with the given category name part
other - return nothing
Indexes
Triggers
Inherited Members
Inherited Properties
- AutoBuildMap
- BuildMapStatus
- CacheSegsGotten
- DocType
- IsMutable
- OriginalDocId
- Parent
- ParentId
- Source
- TimeCreated
- TopParentId
- UserValues
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %CompareContents()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawHTMLForm()
- %DrawHTMLTable()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetContentType()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %OnTimeout()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %ProcessSubmit()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %ShowContents()
- %ShowContentsHead()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- AddChild()
- AddChildArray()
- AppendSegment()
- AppendSegmentId()
- ChildCountGet()
- DrawFormButtons()
- DrawHTMLContentsForm()
- DrawHTMLForm()
- EnumerateVDocsClose()
- EnumerateVDocsExecute()
- EnumerateVDocsFetch()
- FindSegmentValues()
- FindSegmentValuesArray()
- GetChildIdsArray()
- GetMutableSegmentAt()
- GetNewManagerLinks()
- GetSegmentAt()
- GetSegmentIdAt()
- GetSegmentTypeAt()
- GetStatsDimension()
- GetValues()
- GetValuesArray()
- InsertSegmentAt()
- InsertSegmentIdAt()
- IsMutableSet()
- NewSegment()
- NextChild()
- NextChildId()
- ParentGet()
- ParentGetObjectId()
- ParentIdsGet()
- RemoveSegmentAt()
- SetSegmentAt()
- SetSegmentIdAt()
- TopParentIdGet()
- Validate()
- chooseDocType()
- getChildCount()
- getNextChildId()
- getParentIds()
- getTestNewArg()
- getValsArray()
Storage
Storage Model: CacheStorage (EnsLib.EDI.X12.Document)
^EnsLib.EDI.X12.DocumentD(ID,"Attachments",n) | = | Attachments(n) |
^EnsLib.EDI.X12.DocumentD(ID) | = | %%CLASSNAME
ParentId
DocType
IsMutable
TimeCreated
Source
OriginalDocId
Envelope
|
^EnsLib.EDI.X12.DocumentD(ID,"UserValues",n) | = | UserValues(n) |