com.americancoders.edi.ach
Class ACHFunctionalGroup

java.lang.Object
  com.americancoders.edi.SegmentContainer
      com.americancoders.edi.FunctionalGroup
          com.americancoders.edi.ach.ACHFunctionalGroup

All Implemented Interfaces:

java.io.Externalizable, IContainedObject, IDelimiterFetcher, IIdentifier, ISegmentContainer, java.io.Serializable

public class ACHFunctionalGroup

extends FunctionalGroup

class for container Functional_Group

See Also:

Serialized Form

Field Summary

static java.lang.String	idHeader static segment ids
static java.lang.String	idTrailer

Fields inherited from class com.americancoders.edi.FunctionalGroup

myTemplate, parent, transactionSets

Fields inherited from class com.americancoders.edi.SegmentContainer

container, dupSegment, myTemplateContainer

Constructor Summary

ACHFunctionalGroup()
instantiates a functional group

ACHFunctionalGroup(TemplateFunctionalGroup inTFG, IContainedObject inParent)
instantiates a functional group from the definition in an envelope xml rules file.

Method Summary

void	addTransactionSet(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.
char	getDelimiter(char inOriginal) returns the new delimiter based on the old delimiter
TemplateSegmentContainer	getTemplateSegmentContainer() return segment container template
void	setCountInTrailer() set the Transaction Count in the trailer object also sets the trailer "28" field from the headers "28" field
void	validate() validates
void	validate(DocumentErrors inDErr) validates doesn't throw exception but placess error message in DocumentErrors object

Methods inherited from class com.americancoders.edi.FunctionalGroup

getFormattedText, getHeader, getID, getParent, getTemplateSegment, getTrailer, getTransactionSet, getTransactionSetCount, getTransactionSets, getXMLTag, readExternal, setHeaderId, setParent, setTrailerId, toString, trim, writeExternal, writeFormattedText

Methods inherited from class com.americancoders.edi.SegmentContainer

addSegment, addSegment, addSegment, addSegmentToVector, createSegment, createSegment, defineContainer, equivalentSegments, getContainerSize, getSegment, getSegment, getSegment, getSegment, getSegment, getSegment, getSegmentByDataElementValue, getSegmentCount, getSegmentCount, isNull, isSegment, isSegment, isVector, parse, removeSegment, removeSegment, removeSegment, removeSegment, resetToFirstEquivalentSegment, setSegmentAt, setSegmentAt, whyNotUsed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.americancoders.edi.ISegmentContainer

addSegment, createSegment, getSegment, getSegment, getSegmentCount, removeSegment

Field Detail

idHeader

public static final java.lang.String idHeader

static segment ids

See Also:

Constant Field Values

idTrailer

public static final java.lang.String idTrailer

See Also:

Constant Field Values

Constructor Detail

ACHFunctionalGroup

public ACHFunctionalGroup()

instantiates a functional group

ACHFunctionalGroup

public ACHFunctionalGroup(TemplateFunctionalGroup inTFG,
                          IContainedObject inParent)

instantiates a functional group from the definition in an envelope xml rules file.

Method Detail

addTransactionSet

public void addTransactionSet(TransactionSet inTransactionSet)
                       throws OBOEException

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.

Overrides:

addTransactionSet in class FunctionalGroup

Parameters:

inTransactionSet -

Throws:

wrong - TS for this group

OBOEException

setCountInTrailer

public void setCountInTrailer()
                       throws OBOEException

set the Transaction Count in the trailer object also sets the trailer "28" field from the headers "28" field

Specified by:

setCountInTrailer in class FunctionalGroup

Throws:

trailer - not defined yet

OBOEException

validate

public void validate()
              throws OBOEException

validates

Overrides:

validate in class FunctionalGroup

Throws:

OBOEException - indicates why envelope is invalid

validate

public void validate(DocumentErrors inDErr)

validates
doesn't throw exception but placess error message in DocumentErrors object

Overrides:

validate in class FunctionalGroup

getTemplateSegmentContainer

public TemplateSegmentContainer getTemplateSegmentContainer()

Description copied from interface: ISegmentContainer

return segment container template

Returns:

TemplateSegmentContainer

getDelimiter

public char getDelimiter(char inOriginal)

Description copied from interface: IContainedObject

returns the new delimiter based on the old delimiter

Parameters:

inOriginal -

Returns:

newDelimiter character