Open Business Objects for EDI
v3.6.0

Uses of Class
com.americancoders.edi.Segment

Packages that use Segment
com.americancoders.edi   
com.americancoders.edi.ach   
com.americancoders.edi.EDIFact   
com.americancoders.edi.TRADACOMS   
com.americancoders.edi.x12   
com.americancoders.samples   
 

Uses of Segment in com.americancoders.edi
 

Fields in com.americancoders.edi declared as Segment
protected  com.americancoders.edi.Segment ValidXMLEDIParser.segment
          current seg
 

Methods in com.americancoders.edi that return Segment
abstract  com.americancoders.edi.Segment Envelope.getInterchange_Header()
          gets the Interchange Header
abstract  com.americancoders.edi.Segment Envelope.getInterchange_Trailer()
          gets the Interchange Trailer
 com.americancoders.edi.Segment FunctionalGroup.getHeader()
          helper routine to get header segment
 com.americancoders.edi.Segment FunctionalGroup.getTrailer()
          helper routine to get trailer segment
 com.americancoders.edi.Segment ISegmentContainer.getSegment(java.lang.String inID)
          returns a Segment by its ID
 com.americancoders.edi.Segment ISegmentContainer.getSegment(java.lang.String inID, int pos)
          returns a Segment by its ID and position in container
 com.americancoders.edi.Segment ISegmentContainer.createSegment(java.lang.String id)
          creates a static segment
 com.americancoders.edi.Segment Loop.createSegment(java.lang.String ID)
          this is here as a stub because of the Segment container interface
 com.americancoders.edi.Segment SegmentContainer.getSegment(int inPosition)
          returns a Segment by its position
 com.americancoders.edi.Segment SegmentContainer.getSegment(int inPosition, int inVectorPosition)
          returns the Segment inside the subsegment Vector by its position
 com.americancoders.edi.Segment SegmentContainer.getSegment(java.lang.String ID)
          returns a Segment by its ID
 com.americancoders.edi.Segment SegmentContainer.getSegment(java.lang.String ID, int inVectorPosition)
          returns a Segment by its ID and its position in the vector
You must use this method call to get to floating segments
 com.americancoders.edi.Segment SegmentContainer.getSegment(java.lang.String ID, java.lang.String primaryIDValue)
          returns a Segment by its ID and its primaryIDValue
Written for the HIPAA package, but you may find it useful
 com.americancoders.edi.Segment SegmentContainer.getSegment(java.lang.String ID, java.lang.String primaryIDValue, int inPosition)
          returns one of a multiple set of Segments by its ID, its primaryIDValue and its relative position with relation to its primaryIDValue
Written for the HIPAA package, but you may find it useful
 com.americancoders.edi.Segment SegmentContainer.getSegmentByDataElementValue(java.lang.String ID, int inSequence, java.lang.String inValue)
          returns a Segment by its id and the contents of a data field
Used for segments that repeat, useful with IDDE type fields.
 com.americancoders.edi.Segment SegmentContainer.createSegment(java.lang.String id)
          creates a segment by ID
 com.americancoders.edi.Segment SegmentContainer.createSegment(java.lang.String id, java.lang.String primaryIDValue)
          creates a segment by ID and its primary id value
Written for the HIPAA package, but you may find it useful
 com.americancoders.edi.Segment SegmentContainer.createSegmentByIDAndName(java.lang.String code, java.lang.String name)
          creates a segment by ID and its name
Written for the HIPAA package, but you may find it useful
 com.americancoders.edi.Segment TemplateLoopContainer.createSegment(java.lang.String id)
          creates a subsegment
 

Methods in com.americancoders.edi with parameters of type Segment
 void EDIDocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void EDIDocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void EDIDocumentParser.notifyStartSegment(com.americancoders.edi.Segment inSeg)
          method to notifiy handlers when an Segment was just created
 void EDIDocumentParser.notifyEndSegment(com.americancoders.edi.Segment inSeg)
          method to notifiy handlers when processing of an Segment is complete
 void ISegmentContainer.addSegment(com.americancoders.edi.Segment inSegment)
          add a segment to the array
 void SegmentContainer.addSegment(com.americancoders.edi.Segment inSegment)
          add a segment to the array
protected  void SegmentContainer.addSegment(com.americancoders.edi.Segment inSegment, java.lang.Integer inI)
          add a segment to the array
 void SegmentContainer.addSegment(com.americancoders.edi.Segment inSegment, int inPosition)
          adds a Segment to the container by its predefined sequence
 void SegmentContainer.addSegmentToVector(com.americancoders.edi.Segment inSegment, int inPosition)
          adds a Segment to a vectorized segment in the container at a predefined sequence
 void SegmentContainer.setSegmentAt(com.americancoders.edi.Segment inSegment, int inPosition)
          sets a Segment to the container at position in the array, if the Segment is part of the vectorized segment throw exception
 void SegmentContainer.setSegmentAt(com.americancoders.edi.Segment inSegment, int inPosition, int inVectorPosition)
          sets a Segment to the vector at a position container
 

Uses of Segment in com.americancoders.edi.ach
 

Methods in com.americancoders.edi.ach that return Segment
 com.americancoders.edi.Segment ACHEnvelope.getInterchange_Header()
           
 com.americancoders.edi.Segment ACHEnvelope.getInterchange_Trailer()
           
 

Uses of Segment in com.americancoders.edi.EDIFact
 

Methods in com.americancoders.edi.EDIFact that return Segment
 com.americancoders.edi.Segment EDIFactEnvelope.getInterchange_Header()
          gets the Interchange_Header
 com.americancoders.edi.Segment EDIFactEnvelope.getService_String()
          returns the Service String Advice Segment
 com.americancoders.edi.Segment EDIFactEnvelope.getInterchange_Trailer()
          returns the Interchange Control Trailer built for the envelope
 com.americancoders.edi.Segment EDIFactEnvelope.createService_String()
          creates, sets and returns the Service String built for the envelope
 com.americancoders.edi.Segment EDIFactEnvelope.createInterchange_Header()
          creates, sets and returns the Interchange Control Header built for the envelope
 com.americancoders.edi.Segment EDIFactEnvelope.createInterchange_Trailer()
          creates, sets and returns the Interchange Control Trailer built for the envelope
static com.americancoders.edi.Segment Message_Header.getInstance()
          Factory method to create an Message Header
 

Methods in com.americancoders.edi.EDIFact with parameters of type Segment
 void EDIFactDocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void EDIFactDocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 

Uses of Segment in com.americancoders.edi.TRADACOMS
 

Methods in com.americancoders.edi.TRADACOMS that return Segment
 com.americancoders.edi.Segment TradacomsEnvelope.getInterchange_Header()
          gets the Interchange_Header
 com.americancoders.edi.Segment TradacomsEnvelope.getInterchange_Trailer()
          returns the Interchange Control Trailer built for the envelope
 com.americancoders.edi.Segment TradacomsEnvelope.createInterchange_Header()
          creates, sets and returns the Interchange Control Header built for the envelope
 com.americancoders.edi.Segment TradacomsEnvelope.createInterchange_Trailer()
          creates, sets and returns the Interchange Control Trailer built for the envelope
 

Methods in com.americancoders.edi.TRADACOMS with parameters of type Segment
 void TradacomsDocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void TradacomsDocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 

Uses of Segment in com.americancoders.edi.x12
 

Methods in com.americancoders.edi.x12 that return Segment
 com.americancoders.edi.Segment LargeDocumentGenerator.getISA()
           
 com.americancoders.edi.Segment LargeDocumentGenerator.createDeferred_Delivery_Request()
           
 com.americancoders.edi.Segment LargeDocumentGenerator.createGrade_of_Service_Request()
           
 com.americancoders.edi.Segment LargeDocumentGenerator.createInterchange_Acknowledgment()
           
 com.americancoders.edi.Segment LargeDocumentGenerator.startFunctionalGroup()
           
 com.americancoders.edi.Segment X12Envelope.getInterchange_Header()
          returns the Interchange Control Header built for the envelope
 com.americancoders.edi.Segment X12Envelope.getGrade_of_Service_Request()
          gets the Grade_of_Service_Request
 com.americancoders.edi.Segment X12Envelope.getDeferred_Delivery_Request()
          gets the Deferred_Delivery_Request
 com.americancoders.edi.Segment X12Envelope.getInterchange_Acknowledgment(int pos)
          gets a Interchange_Acknowledgment from the vector(container)
check for runtime array out of bounds exception
 com.americancoders.edi.Segment X12Envelope.getInterchange_Trailer()
          returns the Interchange Control Trailer built for the envelope
 com.americancoders.edi.Segment X12Envelope.createInterchange_Header()
          creates, sets and returns the Interchange Control Header built for the envelope
 com.americancoders.edi.Segment X12Envelope.createGrade_of_Service_Request()
          creates, sets and returns the Grade_of_Service_Request
 com.americancoders.edi.Segment X12Envelope.createDeferred_Delivery_Request()
          creates, sets and returns the Deferred_Delivery_Request
 com.americancoders.edi.Segment X12Envelope.createInterchange_Acknowledgment()
          creates, adds and returns a Interchange_Acknowledgment from the vector(container)
check for runtime array out of bounds exception
 com.americancoders.edi.Segment X12Envelope.createInterchange_Trailer()
          creates, sets and returns the Interchange Control Trailer built for the envelope
 

Methods in com.americancoders.edi.x12 with parameters of type Segment
static com.americancoders.edi.TransactionSet Functional_Acknowledgment.postiveAcknowledgment(com.americancoders.edi.TransactionSet tsRespondingTo, com.americancoders.edi.Segment ISASegment)
          Static class method used to generate a 997 transactionSet.
 void LargeDocumentGenerator.addEnvelopeSegment(com.americancoders.edi.Segment seg)
           
 void LargeDocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
           
 void LargeDocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
           
 void X12DocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void X12DocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 

Uses of Segment in com.americancoders.samples
 

Methods in com.americancoders.samples that return Segment
 com.americancoders.edi.Segment build997.buildSegmentTransactionSetHeaderforTableHeader(com.americancoders.edi.Table inTable)
          builds segment ST that is part of the TableHeader
Transaction Set Header used
To indicate the start of a transaction set and to assign a control number
 com.americancoders.edi.Segment build997.buildSegmentFunctionalGroupResponseHeaderforTableHeader(com.americancoders.edi.Table inTable, com.americancoders.edi.FunctionalGroup inFG)
          builds segment AK1 that is part of the TableHeader
Functional Group Response Header used
To start acknowledgment of a functional group
 com.americancoders.edi.Segment build997.buildSegmentTransactionSetResponseHeaderforLoopAK2(com.americancoders.edi.Loop inLoop, com.americancoders.edi.TransactionSet inTS, com.americancoders.edi.DocumentErrors inDErr)
          builds segment AK2 that is part of the LoopAK2
Transaction Set Response Header used
To start acknowledgment of a single transaction set
 com.americancoders.edi.Segment build997.buildSegmentAK4forTableHeaderLoopAK2LoopAK3(com.americancoders.edi.Loop inLoop, java.lang.Object inErrObject, java.lang.String errCode, java.lang.String errID)
          builds segment AK4 that is part of the HeaderAK2AK3
Data Element Note used
To report errors in a data element or composite data structure and identify the location of the data element
 com.americancoders.edi.Segment build997.buildSegmentFunctionalGroupResponseTrailerforTableHeader(com.americancoders.edi.Table inTable, com.americancoders.edi.FunctionalGroup inFG, boolean inErr, int acceptCnt)
          builds segment AK9 that is part of the TableHeader
 com.americancoders.edi.Segment build997.buildSegmentTransactionSetTrailerforTableHeader(com.americancoders.edi.Table inTable)
          builds segment SE that is part of the TableHeader
Transaction Set Trailer used
To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
 

Methods in com.americancoders.samples with parameters of type Segment
 void SampleEDIFactDocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void SampleEDIFactDocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          do nothing when an seg is ended
Note that these segments are only envelope and fg segments NOT SEGMENTS inside of Transaction Sets
 void SampleEDIFactDocumentHandlerAndViewer.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void SampleEDIFactDocumentHandlerAndViewer.endSegment(com.americancoders.edi.Segment inSeg)
          do nothing when an seg is ended
Note that these segments are only envelope and fg segments NOT SEGMENTS inside of Transaction Sets
 void SampleX12DocumentHandler.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void SampleX12DocumentHandler.endSegment(com.americancoders.edi.Segment inSeg)
          do nothing when an seg is ended
Note that these segments are only envelope and fg segments NOT SEGMENTS inside of Transaction Sets
 void SampleX12DocumentHandlerAndViewer.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void SampleX12DocumentHandlerAndViewer.endSegment(com.americancoders.edi.Segment inSeg)
          do nothing when an seg is ended
Note that these segments are only envelope and fg segments NOT SEGMENTS inside of Transaction Sets
 void X12DocumentHandlerXMLBuilder.startSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void X12DocumentHandlerXMLBuilder.endSegment(com.americancoders.edi.Segment inSeg)
          called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
 void build997.checkSegment(com.americancoders.edi.Loop loopAK2forAK3, com.americancoders.edi.Segment testSeg, com.americancoders.edi.DocumentErrors inDErr)
          works with individual segments looking to see if DocumentError object is pointing at it
 


Open Business Objects for EDI
v3.6.0


OBOE is a trademark or registered trademark of American Coders, Ltd. in the US and other countries.
Copyright 1999-2004 American Coders, Ltd.
POB 97462
Raleigh NC 27624 USA
All Rights Reserved.