Open Business Objects for EDI
v3.6.0

Uses of Class
com.americancoders.edi.OBOEException

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

Uses of OBOEException in com.americancoders.edi
 

Methods in com.americancoders.edi that throw OBOEException
 void CharDE.set(byte[] inValue)
          sets the fields contents, not formatted
 java.lang.Object[] CompositeDE.createNewGroup()
          creates a new dearray set for multi-occuring composites
 int CompositeDE.gotoGroup(int inPos)
          moves the cursor to a dearraygroup and resets the group.
 int CompositeDE.resetCursor()
          moves the cursor to the first deArray and sets the deArray
 int CompositeDE.getDEArrayCount()
          returns number of elements in deArrayGroup
 java.lang.Object[] CompositeDE.nextGroup()
          moves the cursor to the next group
 boolean CompositeDE.parse(com.americancoders.edi.ITokenizer TransactionTokenizedString)
          parsing logic for compositeDE
 boolean CompositeDE.parse(java.lang.String TokenizedString, com.americancoders.edi.ITokenizer TransactionTokenizedString)
          parsing logic for compositeDE for repeating composites
 void CompositeDE.parse(java.io.PushbackInputStream pis)
          parses a Fixed Length EDI Document adds to datalement vector or compositeDE and adds to secondary segment vector
 void CompositeDE.parse(org.w3c.dom.Node node)
          parses a XML EDI Document adds to datalement vector
 java.lang.String CompositeDE.getDataElementValue(java.lang.String ID)
           
 java.lang.String CompositeDE.getDataElementValue(int pos)
           
 com.americancoders.edi.DataElement CompositeDE.setDataElementValue(java.lang.String ID, java.lang.String inValue)
           
 com.americancoders.edi.DataElement CompositeDE.setDataElementValue(int pos, java.lang.String inValue)
           
 void DateDE.set(java.lang.String inDate)
          sets the next field value at first field, cursor set to zero stored using an input string in the format YYYYMMDD where YY is year or YYYY is year.
 void DateDE.setNext(java.lang.String inDate)
          sets the next field value by moving cursor, cursor will wrap around stored using an input string in the format YYYYMMDD where YY is year or YYYY is year.
 void DateDE.set(byte[] inValue)
          sets the fields contents, not formatted
 void EDIDocumentHandler.startParsing(java.io.Reader inReader)
          starts the parser with the passed Reader object
abstract  void EDIDocumentParser.parseDocument(java.lang.String s)
          abstract method all document parsers must implement
abstract  void EDIDocumentParser.parseDocument(java.io.Reader r, boolean b)
          abstract method all document parsers must implement
 void EDIXMLParser.parse(java.net.URL inURL, java.lang.String text)
          builds a transaction set by reading a URL NOT USED
 void EDIXMLParser.parse(java.io.InputStream inStream)
          builds a transaction set from input stream
all the work is really done here, the other parse methods call this
abstract  void Envelope.parse(org.w3c.dom.Node node)
           
abstract  boolean Envelope.parse(java.io.PushbackInputStream pis)
           
abstract  java.lang.String Envelope.getFormattedText(int format)
           
abstract  void Envelope.writeFormattedText(java.io.Writer inWriter, int format)
          like getFormattedText; writes to a Writer object instead of building a string.
abstract  void Envelope.validate()
          validate contents of envelope
static int Envelope.getFormat(org.w3c.dom.Node node)
          gets the format of an well formed xml envelope by peeking into the envelope
abstract  void Envelope.setDelimitersInHeader()
          sets the Delimter fields in the header
abstract  void Envelope.setFGCountInTrailer()
          sets the functional group count in the trailer
static com.americancoders.edi.Envelope Envelope.processEDIEnvelope(java.io.InputStream inStream)
           
static com.americancoders.edi.TemplateEnvelope EnvelopeFactory.buildEnvelope(java.lang.String inFileName)
          Deprecated. use buildEnvelope(String, String)
 void FixedLengthParser.parse(java.net.URL inURL, java.lang.String text)
          builds a transaction set by reading a URL NOT USED
 void FixedLengthParser.parse(java.io.InputStream inStream)
          builds a transaction set from input stream
all the work is really done here, the other parse methods call this
 void FunctionalGroup.addTransactionSet(com.americancoders.edi.TransactionSet inTransactionSet)
          add a transaction set to the vector (container)
 void FunctionalGroup.validate()
          validates
abstract  void FunctionalGroup.setCountInTrailer()
          set the Transaction Count in the trailer object
 com.americancoders.edi.CompositeDE ICompositeDEContainer.getCompositeDE(java.lang.String ID)
          returns a CompositeDE from in the Container
since more than one dataelement with the same id can be in the container this is not a very effective method for fetching unique datalements.
 com.americancoders.edi.CompositeDE ICompositeDEContainer.getCompositeDE(int inSequence)
          returns a CompositeDE from the Container
 java.lang.String ICompositeDEContainer.get()
          returns all the data associated in a String format
 void IDDE.set(byte[] inValue)
          sets the fields contents, not formatted
 com.americancoders.edi.DataElement IDataElementContainer.getDataElement(java.lang.String ID)
          returns a DataElement in the Container
since more than one dataelement with the same id can be in the container this is not a very effective method for fetching unique datalements.
 com.americancoders.edi.DataElement IDataElementContainer.getDataElement(int inSequence)
          returns a DataElement in the Container
 java.lang.String IDataElementContainer.getDataElementValue(java.lang.String ID)
          returns the value set in the data element if the data element is not built it will return a zero-length string.
 java.lang.String IDataElementContainer.getDataElementValue(int pos)
          returns the value set in the data element if the data element is not built it will return a zero-length string.
 com.americancoders.edi.DataElement IDataElementContainer.setDataElementValue(java.lang.String ID, java.lang.String inValue)
          returns the value set in the data element if the data element is not built it will return a zero-length string.
 com.americancoders.edi.DataElement IDataElementContainer.setDataElementValue(int pos, java.lang.String inValue)
          sets the value set in the data element without needing to build the data element object if the data element is not built it will be built.
 void ISegmentContainer.addSegment(com.americancoders.edi.Segment inSegment)
          add a segment to the array
 void ISegmentContainer.removeSegment(java.lang.String inID)
          removes a Segment from the segmentArray by id, does this by setting array entry to null can be used to remove all segments with same id at a vectorized position
 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
 void ITemplateElementContainer.addTemplateComposite(com.americancoders.edi.TemplateComposite inTemplateComposite)
           
 com.americancoders.edi.Loop ITemplateLoopContainer.createLoop(java.lang.String ID)
          returns a new Loop
 com.americancoders.edi.TemplateLoop ITemplateLoopContainer.getTemplateLoop(java.lang.String ID)
          returns a Loop
 com.americancoders.edi.TemplateLoop ITemplateLoopContainer.getTemplateLoop(int pos)
          returns a Loop
 void ITemplateLoopContainer.addTemplateLoop(com.americancoders.edi.TemplateLoop templateLoopObject)
          sets a Loop may be used to add a new Loop may be used to change an existing Loop may be used to remove an Loop, this is done by passing a null object
 com.americancoders.edi.TemplateSegment ITemplateSegmentContainer.getTemplateSegment(java.lang.String ID)
          returns a Segment
 com.americancoders.edi.TemplateSegment ITemplateSegmentContainer.getTemplateSegment(int pos)
          returns a Segment
 void ITemplateSegmentContainer.addTemplateSegment(com.americancoders.edi.TemplateSegment templateSegmentObject)
          sets a Segment may be used to add a new Segment may be used to change an existing Segment may be used to remove an Segment, this is done by passing a null object
 com.americancoders.edi.Segment Loop.createSegment(java.lang.String ID)
          this is here as a stub because of the Segment container interface
 boolean LoopAndSegmentContainer.doYouWantThisSegment(java.lang.String inID)
          tests if the seg id is part of this container
 boolean LoopAndSegmentContainer.parse(com.americancoders.edi.ITokenizer TransactionTokenizedString)
          parses the segment portion of an EDI Document, adds to segment vector
 void LoopAndSegmentContainer.parse(org.w3c.dom.Node node)
          parses a XML EDI Document adds to datalement vector or compositeDE and adds to secondary Segment vector
 void LoopAndSegmentContainer.parse(java.io.PushbackInputStream pis)
          parses a Fixed Length EDI Document
 void LoopAndSegmentContainer.addLoop(com.americancoders.edi.Loop inLoop)
          add a Loop to the array
 void LoopAndSegmentContainer.addLoopToVector(com.americancoders.edi.Loop inLoop, int inPosition)
          adds a Loop to a vectorized Loop in the container at a predefined sequence
 void LoopAndSegmentContainer.setLoopAt(com.americancoders.edi.Loop inLoop, int inPosition)
          sets a Loop to the container at position in the array, if the Loop is part of the vectorized Loop throw exception
 void LoopAndSegmentContainer.setLoopAt(com.americancoders.edi.Loop inLoop, int inPosition, int inVectorPosition)
          sets a Loop to the vector at a position container
 void LoopAndSegmentContainer.removeLoop(java.lang.String inID)
          removes a Loop from the container by id, does this by setting array entry to null can be used to remove all Loops with same id at a vectorized position
 void LoopAndSegmentContainer.removeLoop(java.lang.String inID, int inPosition)
          removes a Loop from the container by its ID from the subLoop Vector
 void LoopAndSegmentContainer.removeLoop(int inPosition)
          removes a Loop from the container at a particular position can be used to remove all Loops with same id at a vectorized position
 void LoopAndSegmentContainer.removeLoop(int inPosition, int inVectorPosition)
          removes a Loop from the container at a particular position in the subLoop Vector
 com.americancoders.edi.Loop LoopAndSegmentContainer.getLoop(int inPosition)
          returns a Loop by its position
 com.americancoders.edi.Loop LoopAndSegmentContainer.getLoop(int inPosition, int inVectorPosition)
          returns the Loop inside the subLoop Vector by its position
 com.americancoders.edi.Loop LoopAndSegmentContainer.getLoop(java.lang.String ID)
          returns a Loop by its ID
 com.americancoders.edi.Loop LoopAndSegmentContainer.getLoop(java.lang.String ID, int inVectorPosition)
          returns a Loop by its ID and its position in the vector
You must use this method call to get to floating Loops
 com.americancoders.edi.Loop LoopAndSegmentContainer.getLoopByDataElementValue(java.lang.String ID, int inSequence, java.lang.String inValue)
          returns a Loop by its id and the contents of a data field
Used for Loops that repeat, useful with IDDE type fields.
 com.americancoders.edi.Loop LoopAndSegmentContainer.createLoop(java.lang.String id)
          creates a Loop by ID
 boolean LoopAndSegmentContainer.doYouWantThisNode(org.w3c.dom.Node node)
          tests if the node is part of this container
 boolean LoopAndSegmentContainer.continueParse(com.americancoders.edi.SegmentContainer inContainer, com.americancoders.edi.ITokenizer TransactionSetTokenizer)
          continues to parse an EDI Document after an error.
 void NumericDE.setNext(java.lang.String inValue)
          sets the fields contents by moving cursor, cursor will wrap around
 void NumericDE.set(byte[] inValue)
          sets the fields contents, not formatted
 java.lang.String NumericDE.setFormatted(java.lang.String input)
          sets NumericDE object using an input string
use class set method to set values with assumed decimal
 byte[] ReaderTokenizer.getMoreData(int inLength)
          pulls more data out of reader stream for binarytokenizer
 void RealDE.setNext(java.lang.String inValue)
          sets the fields contents by moving cursor, cursor will wrap around; not formatted
 void RealDE.set(byte[] inValue)
          sets the fields contents, not formatted
 boolean Segment.parse(com.americancoders.edi.ITokenizer TransactionSetTokenizer)
          parses an EDI Document adds to datalement vector and adds to secondary segment vector
 int Segment.parse(org.w3c.dom.Node node)
          parses a XML EDI Document adds to datalement vector or compositeDE and adds to secondary segment vector
 boolean Segment.parse(java.io.PushbackInputStream pis)
          parses a Fixed Length EDI Document adds to datalement vector or compositeDE and adds to secondary segment vector
 java.lang.String Segment.getDataElementValue(java.lang.String ID)
           
 java.lang.String Segment.getDataElementValue(int pos)
           
 com.americancoders.edi.DataElement Segment.setDataElementValue(java.lang.String ID, java.lang.String inValue)
           
 com.americancoders.edi.DataElement Segment.setDataElementValue(int pos, java.lang.String inValue)
           
 boolean SegmentContainer.parse(com.americancoders.edi.ITokenizer TransactionTokenizedString)
          parses the segment portion of an EDI Document, adds to segment vector
 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
 void SegmentContainer.removeSegment(java.lang.String inID)
          removes a Segment from the container by id, does this by setting array entry to null can be used to remove all segments with same id at a vectorized position
 void SegmentContainer.removeSegment(java.lang.String inID, int inPosition)
          removes a Segment from the container by its ID from the subsegment Vector
 void SegmentContainer.removeSegment(int inPosition)
          removes a Segment from the container at a particular position can be used to remove all segments with same id at a vectorized position
 void SegmentContainer.removeSegment(int inPosition, int inVectorPosition)
          removes a Segment from the container at a particular position in the subsegment Vector
 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
 void TemplateComposite.addTemplateComposite(com.americancoders.edi.TemplateComposite inTemplateComposite)
           
 void TemplateDE.setSequence(int inSequence)
          sets the Data Element sequence
 com.americancoders.edi.Segment TemplateLoopContainer.createSegment(java.lang.String id)
          creates a subsegment
 void TemplateSegment.addTemplateComposite(com.americancoders.edi.TemplateComposite inTemplateComposite)
          adds TemplateComposite to container
checks for duplicate entry at sequence position
 com.americancoders.edi.TemplateSegment TemplateSegmentContainer.getTemplateSegment(java.lang.String inID, java.lang.String primaryIDValue)
          gets a templatesegment from the vector by its id and primary id value This method only works if the OBOE.properties property prevalidate is set to true
 boolean TemplateTable.doYouWantThisNode(org.w3c.dom.Node node)
          tests if the node is part of this table
 void TimeDE.set(byte[] inValue)
          sets the fields contents, not formatted
 boolean TransactionSet.parse(com.americancoders.edi.ITokenizer TransactionTokenizedString)
          parses an EDI Document from tokenized string
 boolean TransactionSet.continueParse(com.americancoders.edi.SegmentContainer inContainer, com.americancoders.edi.ITokenizer TransactionTokenizedString)
          continues to parse an EDI Document after an error.
 void TransactionSet.parse(org.w3c.dom.Node node)
          parses a XML EDI Document from a DOM node.
 void TransactionSet.parse(java.io.PushbackInputStream pis)
          parses a FixedLength EDI Document from a Data Input Stream.
 void TransactionSet.validate()
          validates segment syntax for correct DataElements
 void TransactionSet.validate(com.americancoders.edi.DocumentErrors inDErr)
          validates segment syntax for correct DataElements
doesn't throw exception, places error text in DocumentErrors object
static com.americancoders.edi.TransactionSet TransactionSetFactory.buildTransactionSet(java.lang.String inTSID)
          static class method will build a transaction set based on input string and OBOE.properties defintion see OBOE.properties file to define the directory path
static com.americancoders.edi.TransactionSet TransactionSetFactory.buildTransactionSet(java.lang.String inTSID, java.lang.String inSearchDirective, java.lang.String inVersionDirectory, java.lang.String inReceiverIDDirectory, java.lang.String inSenderIDDirectory, java.lang.String inTestOrProductionDirectory)
          static class method will build a transaction set based on input string, the searchDirective, the four search directories and OBOE.properties definition
static com.americancoders.edi.TransactionSet TransactionSetFactory.buildTransactionSet(java.lang.String inTSID, java.lang.String inSearchDirective, java.lang.String inVersionDirectory, java.lang.String inReceiverIDDirectory, java.lang.String inSenderIDDirectory, java.lang.String inTestOrProductionDirectory, boolean inSaveInVectorIndicator)
          static class method will build a transaction set based on input string, the searchDirective, the four search directories and OBOE.properties definition see OBOE.properties file to define the directory path and optional searchDirective.
 

Constructors in com.americancoders.edi that throw OBOEException
BinaryTokenizer(java.lang.String inString, java.lang.String inTokens, com.americancoders.edi.ReaderTokenizer mainTokenizer)
          constructor for Binary Tokenizer (X12 BIN Segments)
first field contains length of data
second field contains binary data (including token seperators)
so if the incoming string is too short, we must go back to the main tokeninzer and ask for the rest of the string
IDListParser()
          constructor, sets up SAX parser, turns off validation, turns on namespaces, sets up content handler and error handler as this object.
Loop(com.americancoders.edi.TemplateLoop inTemplateLoop, com.americancoders.edi.IContainedObject inParent)
          create a Loop based on its template
Tokenizer(com.americancoders.edi.DocumentErrors inDErr)
          builds the parsing object for a transaction set
 

Uses of OBOEException in com.americancoders.edi.ach
 

Methods in com.americancoders.edi.ach that throw OBOEException
 void ACHEnvelope.parse(org.w3c.dom.Node node)
          parses an xml formated file
 boolean ACHEnvelope.parse(java.io.PushbackInputStream inpis)
          method for parsing fixed format edi files
 java.lang.String ACHEnvelope.getFormattedText(int inFormat)
           
 void ACHEnvelope.writeFormattedText(java.io.Writer inWriter, int inFormat)
           
 void ACHEnvelope.validate()
           
 void ACHEnvelope.setDelimitersInHeader()
           
 void ACHEnvelope.setFGCountInTrailer()
           
 void ACHFunctionalGroup.addTransactionSet(com.americancoders.edi.TransactionSet inTransactionSet)
          add a transaction set to the vector (container)
if GS01 is not set then method will set it to the group for the incoming TS, otherwise it will validate the TS group with this FG's group.
 void ACHFunctionalGroup.setCountInTrailer()
          set the Transaction Count in the trailer object also sets the trailer "28" field from the headers "28" field
 void ACHFunctionalGroup.validate()
          validates
 

Constructors in com.americancoders.edi.ach that throw OBOEException
ACHEnvelope(com.americancoders.edi.TemplateEnvelope inTempEnv)
          instantiates the class from a TemplateEnvelope,
ACHTokenizer(java.io.Reader inReader, java.lang.String inType, com.americancoders.edi.DocumentErrors inDErr)
          builds the parsing object for a transaction set
 

Uses of OBOEException in com.americancoders.edi.EDIFact
 

Methods in com.americancoders.edi.EDIFact that throw OBOEException
 void EDIFactDocumentHandler.startParsing(java.io.Reader inReader)
          starts the parser with the passed Reader object
 void EDIFactDocumentParser.parseDocument(java.lang.String inString)
          method that controls the parsing
 void EDIFactDocumentParser.parseDocument(java.io.Reader inReader)
          Deprecated. use parseDocument(Reader, true)
 void EDIFactDocumentParser.parseDocument(java.io.Reader inReader, boolean inValidate)
          method that controls the parsing
 void EDIFactEnvelope.parse(org.w3c.dom.Node node)
           
 boolean EDIFactEnvelope.parse(java.io.PushbackInputStream pis)
           
 void EDIFactEnvelope.setDelimitersInHeader()
          sets the Delimter fields in the header
 void EDIFactEnvelope.writeFormattedText(java.io.Writer inWriter, int inFormat)
           
 void EDIFactEnvelope.validate()
          validates
 void EDIFactEnvelope.validate(com.americancoders.edi.DocumentErrors inDErr)
          validates and places errors in DocumentErrors object
 void EDIFactFunctionalGroup.setCountInTrailer()
          set the Transaction Count in the trailer object
static com.americancoders.edi.Segment Message_Header.getInstance()
          Factory method to create an Message Header
 

Constructors in com.americancoders.edi.EDIFact that throw OBOEException
EDIFactDocumentHandler(java.io.Reader inReader)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
EDIFactDocumentHandler(java.lang.String inString)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
EDIFactEnvelope(com.americancoders.edi.TemplateEnvelope inTempEnv)
          instantiates the class from a TemplateEnvelope, creates mandatory segments UNB and UNZ and creates one emtpy functional group
EDIFactTokenizer(java.io.Reader inReader, com.americancoders.edi.DocumentErrors inDErr)
          builds the parsing object for a transaction set
 

Uses of OBOEException in com.americancoders.edi.TRADACOMS
 

Methods in com.americancoders.edi.TRADACOMS that throw OBOEException
 void TradacomsDocumentHandler.startParsing(java.io.Reader inReader)
          starts the parser with the passed Reader object
 void TradacomsDocumentParser.parseDocument(java.lang.String inString)
          method that controls the parsing
 void TradacomsDocumentParser.parseDocument(java.io.Reader inReader)
          Deprecated. use parseDocument(Reader, boolean)
 void TradacomsDocumentParser.parseDocument(java.io.Reader inReader, boolean inValidate)
          method that controls the parsing
 void TradacomsEnvelope.parse(org.w3c.dom.Node node)
           
 boolean TradacomsEnvelope.parse(java.io.PushbackInputStream pis)
           
 void TradacomsEnvelope.setDelimitersInHeader()
          sets the Delimter fields in the header
 void TradacomsEnvelope.writeFormattedText(java.io.Writer inWriter, int format)
           
 void TradacomsEnvelope.validate()
          validates
 void TradacomsEnvelope.validate(com.americancoders.edi.DocumentErrors inDErr)
          validates and places errors in DocumentErrors object
 void TradacomsFunctionalGroup.setCountInTrailer()
          set the Transaction Count in the trailer object
 

Constructors in com.americancoders.edi.TRADACOMS that throw OBOEException
TradacomsDocumentHandler(java.io.Reader inReader)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
TradacomsEnvelope(com.americancoders.edi.TemplateEnvelope inTempEnv)
          instantiates the class from a TemplateEnvelope, creates mandatory segments STX and END and creates one emtpy functional group
TradacomsTokenizer(java.io.Reader inReader, com.americancoders.edi.DocumentErrors inDErr)
          builds the parsing object for a transaction set
 

Uses of OBOEException in com.americancoders.edi.x12
 

Methods in com.americancoders.edi.x12 that throw OBOEException
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.startParsing(java.io.Reader inReader)
           
 void X12DocumentHandler.startParsing(java.io.Reader inReader)
          starts the parser with the passed Reader object
 void X12DocumentParser.parseDocument(java.lang.String inString)
          parses a String containing an X12 Document and passes results to EDIDocumentHandlers
 void X12DocumentParser.parseDocument(java.io.Reader inReader)
          Deprecated. use parseDocument(Reader, true);
 void X12DocumentParser.parseDocument(java.io.Reader inReader, boolean inValidate)
          parses an X12 Document and passes results to EDIDocumentHandlers
 void X12Envelope.parse(org.w3c.dom.Node node)
           
 boolean X12Envelope.parse(java.io.PushbackInputStream pis)
           
 void X12Envelope.setDelimitersInHeader()
          sets the Delimter fields in the header
 void X12Envelope.setFGCountInTrailer()
          sets the functional group count in the trailer.
 void X12Envelope.writeFormattedText(java.io.Writer inWriter, int inFormat)
           
 void X12Envelope.validate()
          validates
 void X12FunctionalGroup.setCountInTrailer()
          set the Transaction Count in the trailer object also sets the trailer "28" field from the headers "28" field
 void X12FunctionalGroup.validate()
          validates
 

Constructors in com.americancoders.edi.x12 that throw OBOEException
X12DocumentHandler(java.io.Reader inReader)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
X12DocumentHandler(java.lang.String inString)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
X12Envelope(com.americancoders.edi.TemplateEnvelope inTempEnv)
          instantiates the class from a TemplateEnvelope, creates mandatory segments ISA and IEA and creates one emtpy functional group
X12Tokenizer(java.io.Reader inReader, com.americancoders.edi.DocumentErrors inDErr)
          builds the parsing object for a transaction set
 

Uses of OBOEException in com.americancoders.samples
 

Methods in com.americancoders.samples that throw OBOEException
 void X12DocumentHandlerXMLBuilder.startParsing(java.io.Reader inReader)
          starts the parser with the passed Reader object
 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.Loop build997.buildLoopTransactionSetResponseHeaderforTableHeader(com.americancoders.edi.Table inTable, com.americancoders.edi.FunctionalGroup inFG, com.americancoders.edi.DocumentErrors inDErr)
          builds loop AK2 that is part of the TableHeader
Transaction Set Response Header used
 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.Loop build997.buildLoopAndSegmenAK3forTableHeaderLoopAK2(com.americancoders.edi.Loop inLoop, java.lang.String errID, int errPos)
          builds loop and segment AK3 that is part of the TableHeader LoopAK2
Data Segment Note used
To report errors in a data segment and identify the location of the data segment
 com.americancoders.edi.Loop build997.buildLoopAndSegmenAK3forTableHeaderLoopAK2(com.americancoders.edi.Loop inLoop, java.lang.String errID, int errPos, java.lang.String errCode)
          builds loop and segment AK3 that is part of the HeaderAK2
Data Segment Note used
To report errors in a data segment and identify the location of the data segment
 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
 void build997.buildSegmentTransactionSetResponseTrailerforLoopAK2(com.americancoders.edi.Loop inLoop, java.lang.String accRej, java.lang.String code)
          builds segment AK5 that is part of the HeaderAK2
Transaction Set Response Trailer used
To acknowledge acceptance or rejection and report errors in a transaction set
 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)
 

Constructors in com.americancoders.samples that throw OBOEException
X12DocumentHandlerXMLBuilder(java.io.Reader inReader)
          create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available
build997(com.americancoders.edi.x12.X12Envelope inEnv, com.americancoders.edi.DocumentErrors inDErr)
          constructor for class build997
 


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.