Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [EDI] >  [BatchDocument]
Private  Storage   

abstract class EnsLib.EDI.BatchDocument extends EnsLib.EDI.Document

Common base class for VDoc documents that can contain other VDoc documents of the same type

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 14


Summary

Properties
ChildCount DocType DocTypeCategory DocTypeName
Identifier IsMutable Name OriginalDocId
Parent ParentId ParentIds RawContent
Source TimeCreated TopParentId TypeVersion
UserValues

Methods
AddChild AddChildArray ChildCountGet CopyValues
DrawFormButtons DrawHTMLContentsForm DrawHTMLForm EnumerateDocTypesClose
EnumerateDocTypesExecute EnumerateDocTypesFetch EnumerateTypeCategoriesClose EnumerateTypeCategoriesExecute
EnumerateTypeCategoriesFetch EnumerateVDocsClose EnumerateVDocsExecute EnumerateVDocsFetch
GetAlias GetChildIdsArray GetContentArray GetManagerLinks
GetNewManagerLinks GetNextIndex GetValueAt IsMutableSet
NextChild NextChildId ParentGet ParentGetObjectId
ParentIdsGet PokeDocType SetValueAt TopParentIdGet
TypeVersionGet Validate getChildCount getNextChildId
getParentIds getTestNewArg resolveChildDocType

Subclasses
EnsLib.EDI.EDIFACT.Document EnsLib.EDI.X12.Document

Properties

• property ChildCount as %Integer [ Calculated,Transient,ReadOnly ];
Number of Children
• property Parent as EnsLib.EDI.Document [ Calculated,Transient,ReadOnly ];
An object representing the original immediate parent document of this nested document, if nested
• property ParentId as %String(COLLATION="EXACT",MAXLEN="");
The ID:SegIndex of the immediate parent document of this nested document, if nested
• property ParentIds as %String [ Calculated,Transient,ReadOnly ];
A $List of the ID:SegIndex's of all the enclosing parent documents of this nested document, if nested,in order from from immediate to outermost. E.g. for Id of enclosing batch document if we are a document within a batch document
• property TopParentId as %String [ Calculated,Transient,ReadOnly ];
The ID:SegIndex of the outermost parent document of this nested document, if nested

Methods

• method AddChild(pRefSegIndex As %Integer, pChild...) as %Status
To the current batch parent object, add one or more child objects as children of the DocsRef placeholder segment referenced by its index position in pRefSegIndex. (This is 2 for a simple batch parent with 3 segments: Header, DocsRef, and Trailer segments.)
• method AddChildArray(pRefSegIndex As %Integer, ByRef pChildren) as %Status
To the current batch parent object, add one or more child objects as children of the DocsRef placeholder segment referenced by its index position in pRefSegIndex. (This is 2 for a simple batch parent with 3 segments: Header, DocsRef, and Trailer segments.) The children are objects passed as numbered subscript values in array pChildren whose top value is the count of child object values.
• method ChildCountGet(pParentRef As %String = "") as %Status
This is a Get accessor method for the ChildCount property.
• classmethod GetChildIdsArray(ByRef pArray, pParentId As %String, pLeavesOnly As %Boolean = 0) as %Status
• method NextChild(pChild As EnsLib.EDI.Document = $$$NULLOREF, pRefSegIndex As %String) as EnsLib.EDI.Document
• method NextChildId(pId As %String, pRefSegIndex As %String) as %String
• method ParentGet() as EnsLib.EDI.Document
This is a Get accessor method for the Parent property.
• method ParentGetObjectId(force As %Integer) as %String
Required for AutoForm
• method ParentIdsGet() as %String
This is a Get accessor method for the ParentIds property.
• method TopParentIdGet() as %String
This is a Get accessor method for the TopParentId property.
• classmethod getChildCount(pId As %String, pRefSegIndex As %String = "") as %Status
• classmethod getNextChildId(pParentId As %String, pId As %String = "", pRefSegIndex As %String = "") as %String
• classmethod getParentIds(pParentRef, pSkipOne=0) as %String
• method resolveChildDocType() as %String
Implemented in subclasses


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.