Class EnsLib.EDI.SEF.Segment

class EnsLib.EDI.SEF.Segment extends EnsLib.EDI.SEF.Node

This represents a segment definition from the SEGS section of the SEF file

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	5	4

Summary

Properties
Masks	Name	Nodes	Parent	Relations
Table

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OnNew	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	Ancestor	AsString	DisplayName
GenerateDescriptor	GenerateText	IsGroup	Mask
OutputTextToDevice	Validate

Properties

• property Masks as EnsLib.EDI.SEF.SegmentMaskList;

This holds the optional mask list

• property Name as %String;

This holds the name of the Segment

• property Nodes as EnsLib.EDI.SEF.NodeList;

This holds the contents of the Segment, these may be elements, composites or SegmentItemGroups

• property Relations as EnsLib.EDI.SEF.NodeList;

This holds the optional Relation

• property Table as %Integer;

This holds the table number

Methods

• method %OnNew(initvalue As %RawString) as %Status

This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• 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 Mask() as EnsLib.EDI.SEF.SegmentMask

Return the in-use mask as indicated by SetSegment definition. If no mask is in use, return nulloref

• method Validate(ByRef pStatus As %Status) as %Status

Perform a sanity check on the nodes in the parse tree

Class Reference IRIS for UNIX 2024.1.2
Documentation Search