com.americancoders.edi
Interface ITemplateSegmentContainer

All Known Implementing Classes:

TemplateSegmentContainer

public interface ITemplateSegmentContainer

interface for Segment Container
used by tables and segments

OBOE - Open Business Objects for EDI
An EDI and XML Translator Written In Java
Copyright 1998-2007 - American Coders, LTD - Raleigh NC USA
All rights reserved
American Coders, Ltd
P. O. Box 97462
Raleigh, NC 27624 USA
1-919-846-2014
http://www.americancoders.com

Version:

3.5.2

Author:

Joe McVerry - American Coders, Ltd.

Method Summary

void	addTemplateSegment(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
int	getCount() implemented for interface
TemplateSegment	getTemplateSegment(int pos) returns a Segment
TemplateSegment	getTemplateSegment(java.lang.String ID) returns a Segment

Method Detail

getTemplateSegment

public TemplateSegment getTemplateSegment(java.lang.String ID)
                                   throws OBOEException

returns a Segment

Parameters:

ID - String ID of TemplateSegment to look for

Returns:

Segment objects - null indicates segment not set

Throws:

OBOEException - ID is unknown to this Segment

getTemplateSegment

public TemplateSegment getTemplateSegment(int pos)
                                   throws OBOEException

returns a Segment

Parameters:

pos - int pos TemplateSegment to look for

Returns:

Segment objects - null indicates segment not set

Throws:

OBOEException - ID is unknown to this Segment

addTemplateSegment

public void addTemplateSegment(TemplateSegment templateSegmentObject)
                        throws OBOEException

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

Parameters:

templateSegmentObject - TemplateSegment to be added

Throws:

OBOEException - Segment is unknown

getCount

public int getCount()

implemented for interface

Returns:

int