Online Help TEDIFunctionalGroup

Unit JclEDI_ANSIX12, JclEDI_UNEDIFACT

Types

TEDIFunctionalGroup

   The TEDIFunctionGroup object contains and manages TEDITransactionSet objects.

   In JclEDI_UNEDIFACT.pas: The TEDIFunctionalGroup object contains and manages TEDIMessage objects instead of TEDITransactionSet objects.

   Since JclEDI_UNEDIFACT.pas uses TEDIMessage instead of TEDITransactionSet objects there are some differences in the implementation of TEDIFunctionalGroup between JclEDI_ANSIX12.pas and JclEDI_UNEDIFACT.pas units.

 Procedure

procedure InternalCreateHeaderTrailerSegments; virtual;

   InternalCreateHeaderTrailerSegments creates the EDI functional group header and trailer segments and is called in the constructor.

   It is important to note that the TEDIFunctionalGroup object does not make any assumptions on the data contained within the functional group header or trailer segments, and it is up the programmer to accurately maintain the data within these segments.

   For custom EDI implementations the functional group header and trailer segments can be used with a varying number of elements.

 In JclEDI_ANSIX12.pas: Properties

property SegmentGS: TEDIFunctionalGroupSegment
  read FGSSegment write SetGSSegment;
property SegmentGE: TEDIFunctionalGroupSegment
  read FGESegment write SetGESegment;

   The SegmentGS property is the functional group header segment. The "GS" segment contains the following data elements in ANSI X12.

  • Functional Identifier Code
  • Application Sender’s Code
  • Application Receiver’s Code
  • Date
  • Time
  • Group Control Number
  • Responsible Agency Code
  • Version / Release / Industry Identifier Code

   The SegmentGE property is the functional group trailer segment. The "GE" segment contains the following data elements in ANSI X12.

  • Number of Transaction Sets Included
  • Group Control Number

 In JclEDI_UNEDIFACT.pas: Properties

property SegmentUNG: TEDIFunctionalGroupSegment
  read FUNGSegment write SetUNGSegment;
property SegmentUNE: TEDIFunctionalGroupSegment
  read FUNESegment write SetUNESegment;

   The SegmentUNG property is the functional group header segment.

   The SegmentUNE property is the functional group trailer segment.

 Function

function Assemble: string; override;

   This function implements the assembling of EDI data into EDI file format.

 Procedure

procedure Disassemble; override;

   This procedure implements the disassembling of EDI data from EDI file format.

 In JclEDI_ANSIX12.pas: Function

function InternalCreateTransactionSet: TEDITransactionSet; virtual;

   InternalCreateTransactionSet will create a TEDITransactionSet object and is used by InternalCreateEDIDataObject.

 In JclEDI_UNEDIFACT.pas: Function

function InternalCreateMessage: TEDIMessage; virtual;

   InternalCreateMessage will create a TEDIMessage object and is used by InternalCreateEDIDataObject.

 Function

function InternalAssignDelimiters: TEDIDelimiters; override;

   Acquires a TEDIDelimiter reference from the TEDIFunctionalGroup parent object.

 Function

function InternalCreateEDIDataObject: TEDIDataObject; override;

   In JclEDI_ANSIX12.pas: This function calls InternalCreateTransactionSet.

   In JclEDI_UNEDIFACT.pas: This function calls InternalCreateMessage.

 In JclEDI_ANSIX12.pas: Functions and Procedures

function AddTransactionSet: Integer;
function AppendTransactionSet(TransactionSet: TEDITransactionSet): Integer;
function InsertTransactionSet(InsertIndex: Integer): Integer; overload;
function InsertTransactionSet(InsertIndex: Integer;
  TransactionSet: TEDITransactionSet): Integer; overload;
procedure DeleteTransactionSet(Index: Integer); overload;
procedure DeleteTransactionSet(TransactionSet: TEDITransactionSet); overload;
function AddTransactionSets(Count: Integer): Integer;
function AppendTransactionSets(TransactionSetArray: TEDITransactionSetArray): Integer;
function InsertTransactionSets(InsertIndex, Count: Integer): Integer; overload;
function InsertTransactionSets(InsertIndex: Integer;
  TransactionSetArray: TEDITransactionSetArray): Integer; overload;
procedure DeleteTransactionSets; overload;
procedure DeleteTransactionSets(Index, Count: Integer); overload;

   Transaction set item management functions and procedures.

 In JclEDI_UNEDIFACT.pas: Functions and Procedures

function AddMessage: Integer;
function AppendMessage(Message: TEDIMessage): Integer;
function InsertMessage(InsertIndex: Integer): Integer; overload;
function InsertMessage(InsertIndex: Integer;
  Message: TEDIMessage): Integer; overload;
procedure DeleteMessage(Index: Integer); overload;
procedure DeleteMessage(Message: TEDIMessage); overload;
function AddMessages(Count: Integer): Integer;
function AppendMessages(MessageArray: TEDIMessageArray): Integer;
function InsertMessages(InsertIndex, Count: Integer): Integer; overload;
function InsertMessages(InsertIndex: Integer;
  MessageArray: TEDIMessageArray): Integer; overload;
procedure DeleteMessages; overload;
procedure DeleteMessages(Index, Count: Integer); overload;

   Message item management functions and procedures.

 In JclEDI_ANSIX12.pas: Property

property TransactionSet[Index: Integer]: TEDITransactionSet
  read GetTransactionSet write SetTransactionSet; default;

   This property allows direct and easy access to the TEDITransactionSet objects managed by the object list in TEDIFunctionalGroup.

 In JclEDI_ANSIX12.pas: Property

property TransactionSets: TEDIDataObjectList read FEDIDataObjects;

   A property that exposes the object list in TEDIFunctionalGroup.

 In JclEDI_ANSIX12.pas: Property

property TransactionSetCount: Integer read GetCount;

   Gets the count of TEDITransactionSet objects.

 In JclEDI_UNEDIFACT.pas: Property

property Message[Index: Integer]: TEDIMessage read GetMessage
  write SetMessage; default;

   This property allows direct and easy access to the TEDIMessage objects managed by the object list in TEDIFunctionalGroup.

 In JclEDI_UNEDIFACT.pas: Property

property Messages: TEDIDataObjectList read FEDIDataObjects;

   A property that exposes the object list in TEDIFunctionalGroup.

 In JclEDI_UNEDIFACT.pas: Property

property MessageCount: Integer read GetCount;

   Gets the count of TEDIMessage objects.

Usage

Notes & Examples

< Under Construction >