Open Business Objects for EDI
v3.6.0

com.americancoders.edi
Class TemplateEnvelope

java.lang.Object
  |
  +--com.americancoders.edi.TemplateSegmentContainer
        |
        +--com.americancoders.edi.TemplateEnvelope
All Implemented Interfaces:
java.io.Externalizable, IContainedObject, IIdentifier, ITemplateSegmentContainer, java.io.Serializable

public class TemplateEnvelope
extends TemplateSegmentContainer
implements java.io.Externalizable

class for Template Envelopes

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2009 - 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.6.0
Author:
Joe McVerry - American Coders, Ltd.
See Also:
Serialized Form

Field Summary
protected  java.util.Hashtable idListFileList
          store idListFile datetime stamp
protected  com.americancoders.edi.IContainedObject parent
           
protected  java.lang.String xmlPath
           
 
Fields inherited from class com.americancoders.edi.TemplateSegmentContainer
templateContainer
 
Constructor Summary
TemplateEnvelope()
          creates a TemplateEnvelope object
 
Method Summary
 void addIDListFile(java.io.File inFile)
           
 boolean checkIDListFiles()
           
 java.lang.String getID()
          return the ID
 com.americancoders.edi.IContainedObject getParent()
          gets parent attribute
 com.americancoders.edi.TemplateFunctionalGroup getTemplateFunctionalGroup()
          returns the template functional group used by this envelope
 com.americancoders.edi.TemplateFunctionalGroup getTfg()
          returns template functional group object
 java.lang.String getType()
          returns type of envelope
 java.lang.String getXMLTag()
          gets the xml tag
 void readExternal(java.io.ObjectInput in)
          used by externalize methods
 void setParent(com.americancoders.edi.IContainedObject inParent)
          sets parent attribute
 void setTemplateFunctionalGroup(com.americancoders.edi.TemplateFunctionalGroup inTFG)
          sets the template functional group used by this envelope
 void setTfg(com.americancoders.edi.TemplateFunctionalGroup group)
           
 void setType(java.lang.String string)
           
 void setXMLPath(java.lang.String string)
           
 void writeExternal(java.io.ObjectOutput out)
          used by externalize methods
 
Methods inherited from class com.americancoders.edi.TemplateSegmentContainer
addTemplateSegment, getCount, getCount, getTemplateSegment, getTemplateSegment, getTemplateSegment, getTemplateSegmentByIDAndName, isSegment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

idListFileList

protected java.util.Hashtable idListFileList
store idListFile datetime stamp


parent

protected com.americancoders.edi.IContainedObject parent

xmlPath

protected java.lang.String xmlPath
Constructor Detail

TemplateEnvelope

public TemplateEnvelope()
creates a TemplateEnvelope object

Method Detail

getTemplateFunctionalGroup

public com.americancoders.edi.TemplateFunctionalGroup getTemplateFunctionalGroup()
returns the template functional group used by this envelope

Returns:
templatefunctionalgroup

setTemplateFunctionalGroup

public void setTemplateFunctionalGroup(com.americancoders.edi.TemplateFunctionalGroup inTFG)
sets the template functional group used by this envelope

Parameters:
inTFG - templatefunctionalgroup

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
used by externalize methods

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
in - ObjectInput stream
Throws:
java.io.IOException - - most likely class changed since written
java.lang.ClassNotFoundException - - only when dummy constructro not found

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
used by externalize methods

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
out - ObjectOutput stream
Throws:
java.io.IOException - Java.io error

setParent

public void setParent(com.americancoders.edi.IContainedObject inParent)
sets parent attribute

Specified by:
setParent in interface IContainedObject
Parameters:
inParent - TemplateSegmentContainer

getParent

public com.americancoders.edi.IContainedObject getParent()
gets parent attribute

Specified by:
getParent in interface IContainedObject
Returns:
TemplateSegmentContainer

getID

public java.lang.String getID()
Description copied from interface: IIdentifier
return the ID

Specified by:
getID in interface IIdentifier
Returns:
String

getXMLTag

public java.lang.String getXMLTag()
Description copied from interface: IIdentifier
gets the xml tag

Specified by:
getXMLTag in interface IIdentifier
Returns:
String

getTfg

public com.americancoders.edi.TemplateFunctionalGroup getTfg()
returns template functional group object

Returns:
TemplateFunctioanlGroup

getType

public java.lang.String getType()
returns type of envelope

Returns:
string

setTfg

public void setTfg(com.americancoders.edi.TemplateFunctionalGroup group)
Parameters:
group -

setType

public void setType(java.lang.String string)
Parameters:
string -

setXMLPath

public void setXMLPath(java.lang.String string)

addIDListFile

public void addIDListFile(java.io.File inFile)

checkIDListFiles

public boolean checkIDListFiles()

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.