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.IOFormatInterface

EnsLib.EDI.IOFormatInterface

abstract class EnsLib.EDI.IOFormatInterface

Method Inventory (Including Private)

Methods (Including Private)

abstract classmethod ImportDocument(Output pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, ByRef pContext As %String) as %Boolean
Return 1 if we imported the whole document or got an error. Returning 0 means the caller will do its standard parse.
abstract classmethod ImportSegment(Output pSegObj As EnsLib.EDI.Segment, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, ByRef pContext As %String) as %Boolean
Return 1 if we imported a segment or got an error. Returning 0 means the caller will do its standard parse.
abstract classmethod OutputDocument(pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, ByRef pContext As %String) as %Boolean
Return 1 if we took care of the whole document or got an error. Returning 0 means the caller will continue doing component segments as usual.
abstract classmethod OutputDocumentEnd(pDocObj As EnsLib.EDI.Document, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, pSequenceNumber As %String)
Output any post-segment trailing document content. Called only if OutputDocument() returned 0 meaning it did not complete output of all segments itself.
classmethod OutputSegment(pSegObj As EnsLib.EDI.Segment, Output pStatus As %Status, pIOStream As %IO.I.CharacterStream, pSeparators As %String, pSegNum As %String, pSegPath As %String, pParentDoc As EnsLib.EDI.Document, ByRef pContext As %String) as %Boolean
Return 1 if we took care of the segment or got an error. Returning 0 means the caller will output the segment as usual.

Subclasses

FeedbackOpens in a new window