This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.EDI.SEF.SetSegment

EnsLib.EDI.SEF.SetSegment

class EnsLib.EDI.SEF.SetSegment extends EnsLib.EDI.SEF.CommonNode

Represents a Segment referenced in a SET

Property Inventory

Method Inventory

Properties

property GroupTrigger as %Boolean [ InitialExpression = 0 ];
This holds the GroupTrigger flag
Property methods: GroupTriggerDisplayToLogical(), GroupTriggerGet(), GroupTriggerIsValid(), GroupTriggerLogicalToDisplay(), GroupTriggerNormalize(), GroupTriggerSet()
property Mask as %Integer;
This is the optional mask spec
Property methods: MaskDisplayToLogical(), MaskGet(), MaskIsValid(), MaskLogicalToDisplay(), MaskNormalize(), MaskSet()
property Name as %String;
This holds the segment name
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Ordinal as %Integer;
This holds the calculated ordinal number within the SET definition
Property methods: OrdinalDisplayToLogical(), OrdinalGet(), OrdinalIsValid(), OrdinalLogicalToDisplay(), OrdinalNormalize(), OrdinalSet(), OrdinalSpecDisplayToLogical(), OrdinalSpecGet(), OrdinalSpecIsValid(), OrdinalSpecLogicalToDisplay(), OrdinalSpecLogicalToOdbc(), OrdinalSpecNormalize(), OrdinalSpecSet()
property OrdinalSpec as %String;
This holds the ordinal spec
Property methods: OrdinalSpecDisplayToLogical(), OrdinalSpecGet(), OrdinalSpecIsValid(), OrdinalSpecLogicalToDisplay(), OrdinalSpecLogicalToOdbc(), OrdinalSpecNormalize(), OrdinalSpecSet()
property Position as %Integer;
This holds the calculated position number within the SET definition
Property methods: PositionDisplayToLogical(), PositionGet(), PositionIsValid(), PositionLogicalToDisplay(), PositionModifierDisplayToLogical(), PositionModifierGet(), PositionModifierIsValid(), PositionModifierLogicalToDisplay(), PositionModifierLogicalToOdbc(), PositionModifierNormalize(), PositionModifierSet(), PositionNormalize(), PositionSet()
property PositionModifier as %String;
This holds the position modifier
Property methods: PositionModifierDisplayToLogical(), PositionModifierGet(), PositionModifierIsValid(), PositionModifierLogicalToDisplay(), PositionModifierLogicalToOdbc(), PositionModifierNormalize(), PositionModifierSet()
property Segment as EnsLib.EDI.SEF.Segment;
This holds the the Segment parsed from the corresponding segment definition from the .SEGS section of the SEF file
Property methods: SegmentGet(), SegmentGetSwizzled(), SegmentIsValid(), SegmentNewObject(), SegmentSet()

Methods

method GenerateDescriptor(pCompiler As EnsLib.EDI.SEF.Compiler) as %Status
This method is overriden by subclasses to generate the code that this node represents
method GenerateText(pStream As %CharacterStream) as %Status
This method is override by subclases to generate the textual representation of this node
method RepeatCountGet() as %String
Accessor for RepeatCount. The repeat count for the first segment in a loop or group (group trigger) is always 1, regardless of what is specified in the maximum field in the SEF file. If the repeat count for such a segment is ommitted, or coded as something else, it should nevertheless be interpreted as 1
method Validate(ByRef pStatus As %Status) as %Status
Perform a sanity check on the nodes in the parse tree

Inherited Members

Inherited Properties

Inherited Methods