abstract class EnsLib.EDI.Segment
extends EnsLib.EDI.Document
Common base class for VDoc classes that have Separators and are non-persistent, being objects representing Segments that compose an instance of a "Segmented" VDoc class
• property Count
as %Integer [ Calculated,ReadOnly ];
Number of Fields
• property ID
as %String [ ReadOnly ];
Index into Segment Storage
• property IsMutable
as %Boolean [ ReadOnly ];
We clear this property to prevent saving or modifying of already-saved document objects
• property Separators
as %String;
All Separators as a single String
• method FindValues(pPropertyPath As %String = "", pSeparators As %String, pValSepString As %String = "<>", pSchemaCategory As %String, Output pStatus As %Status = $$$OK)
as %String
• method FindValuesArray(pPropertyPath As %String = "", pSeparators As %String, ByRef pArray As %String, pSchemaCategory As %String, Output pStatus As %Status = $$$OK, ByRef pLongArray As %String)
• abstract method GetNextIndex(pPath As %String, pIndex As %String, ByRef pStatus As %Status)
as %String
Gets the next index in an array by path
• abstract method GetValueAt(pPropertyPath As %String = "", pSeparators As %String = "", Output pStatus As %Status, pTreatEmptyFieldAsNull As %Boolean = 0)
as %String
Returns the value at the specified property path. The separators argument is used to specify the
separators to be used when a non-atomic value is returned. Status is returned via the Status output variable.
A boolean value pTreatEmptyFieldAsNull indicates whether repeating fields which have a separator but are empty should be considered to have a count of 1 (if false) or 0 (if true)
• method IsChildHolder(Output pRefSegIndex As %String)
as %Boolean
• abstract method SaveData()
as %Status
• method SetValueAt(pValue As %String, pPropertyPath As %String = "", pKey As %String = "", pAction As %String = "set")
as %Status
Sets a value at the specified property path. Typically the key is used to specify arguments which may
be matched at run-time with place-holders in the property path. The action corresponds to the actions in the
DTL statement
• abstract method Validate(pPath As %String)
as %Status
Validate a segment item
