com.americancoders.edi
Interface ITemplateLoopContainer

public interface ITemplateLoopContainer

interface for Loop Container
used by tables and Loops

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	addTemplateLoop(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
Loop	createLoop(java.lang.String ID) returns a new Loop
TemplateLoop	getTemplateLoop(int pos) returns a Loop
TemplateLoop	getTemplateLoop(java.lang.String ID) returns a Loop
int	getTemplateLoopSize() implemented for interface

Method Detail

createLoop

public Loop createLoop(java.lang.String ID)
                throws OBOEException

returns a new Loop

Parameters:

ID - String id of Loop to create

Returns:

Loop objects - null indicates Loop not set

Throws:

OBOEException - ID is unknown to this Loop

getTemplateLoop

public TemplateLoop getTemplateLoop(java.lang.String ID)
                             throws OBOEException

returns a Loop

Parameters:

ID - String ID of TemplateLoop to look for

Returns:

Loop objects - null indicates Loop not set

Throws:

OBOEException - ID is unknown to this Loop

getTemplateLoop

public TemplateLoop getTemplateLoop(int pos)
                             throws OBOEException

returns a Loop

Parameters:

pos - int pos TemplateLoop to look for

Returns:

Loop objects - null indicates Loop not set

Throws:

OBOEException - ID is unknown to this Loop

addTemplateLoop

public void addTemplateLoop(TemplateLoop templateLoopObject)
                     throws OBOEException

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

Parameters:

templateLoopObject - TemplateLoop to be added

Throws:

OBOEException - Loop is unknown

getTemplateLoopSize

public int getTemplateLoopSize()

implemented for interface

Returns:

int