Open Business Objects for EDI
v3.6.0

com.americancoders.edi
Class TemplateTransactionSet

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

public class TemplateTransactionSet
extends java.lang.Object
implements java.io.Externalizable, IContainedObject

class for Template Transaction Sets

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  java.util.Hashtable knownComposites
           
protected  java.util.Hashtable knownDataElement
           
protected  java.util.Hashtable knownSegments
           
protected  com.americancoders.edi.IContainedObject parent
          parent container
 
Constructor Summary
TemplateTransactionSet()
          creates a Template transactionset object
TemplateTransactionSet(int inFormat, java.lang.String inId, java.lang.String inName, java.lang.String inRevision, java.lang.String inFunctionalGroup, java.lang.String inShortDescription, java.lang.String inXMLTag, com.americancoders.edi.IContainedObject inParent)
          constructs a Template Transaction Set
 
Method Summary
 void addIDListFile(java.io.File inFile)
           
 boolean checkIDListFiles()
           
 com.americancoders.edi.TemplateTable getDetailTemplateTable()
          returns detail TemplateTable for the Transaction Set
 int getFormat()
          returns the Transaction Set format
 java.lang.String getFunctionalGroup()
          returns functional group string
 com.americancoders.edi.TemplateTable getHeaderTemplateTable()
          returns header TemplateTable for the Transaction Set
 java.lang.String getID()
          returns the Transaction Set id
 java.util.Hashtable getKnownComposites()
           
 java.util.Hashtable getKnownDataElement()
           
 java.util.Hashtable getKnownSegments()
           
 java.lang.String getName()
          returns name for the Transaction Set
 com.americancoders.edi.IContainedObject getParent()
          gets parent attribute
 java.lang.String getRevision()
          returns revision value for the Transaction Set
 java.lang.String getShortDescription()
          returns the Short Description for the Transaction Set
 com.americancoders.edi.TemplateTable getSummaryTemplateTable()
          returns summary TemplateTable for the Transaction Set
 java.lang.String getXMLTag()
          returns the xml tag field
 void readExternal(java.io.ObjectInput in)
          used by externalize methods
 void setDetailTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
          sets detail TemplateTable for the Transaction Set
 void setFormat(int inFormat)
          sets format for the Transaction Set
XML_FORMAT = 1;
X12_FORMAT = 2;
EDIFACT_FORMAT = 3;
VALID_XML_FORMAT = 4;
 void setFunctionalGroup(java.lang.String inFunctionalGroup)
          sets Function Group for the Transaction Set
 void setHeaderTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
          sets header TemplateTable for the Transaction Set
 void setID(java.lang.String inId)
          sets id for the Transaction Set
 void setName(java.lang.String inName)
          sets name for the Transaction Set
 void setParent(com.americancoders.edi.IContainedObject inParent)
          sets parent attribute
 void setRevision(java.lang.String inRevision)
          sets Revision for the Transaction Set
 void setShortDescription(java.lang.String inDesc)
          sets Short Description for the Transaction Set
 void setSummaryTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
          sets summary TemplateTable for the Transaction Set
 void setXMLTag(java.lang.String inXMLTag)
          sets the xml tag field
 void writeExternal(java.io.ObjectOutput out)
          used by externalize methods
 
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


knownSegments

protected java.util.Hashtable knownSegments

knownComposites

protected java.util.Hashtable knownComposites

knownDataElement

protected java.util.Hashtable knownDataElement

parent

protected com.americancoders.edi.IContainedObject parent
parent container

Constructor Detail

TemplateTransactionSet

public TemplateTransactionSet()
creates a Template transactionset object


TemplateTransactionSet

public TemplateTransactionSet(int inFormat,
                              java.lang.String inId,
                              java.lang.String inName,
                              java.lang.String inRevision,
                              java.lang.String inFunctionalGroup,
                              java.lang.String inShortDescription,
                              java.lang.String inXMLTag,
                              com.americancoders.edi.IContainedObject inParent)
constructs a Template Transaction Set

Parameters:
inFormat - int format
inId - String ts id
inName - String name
inRevision - String revision or version
inFunctionalGroup - String functional group
inShortDescription - String short description
inXMLTag - String xml tag
inParent - owning Object
Method Detail

setFormat

public void setFormat(int inFormat)
sets format for the Transaction Set
XML_FORMAT = 1;
X12_FORMAT = 2;
EDIFACT_FORMAT = 3;
VALID_XML_FORMAT = 4;

Parameters:
inFormat - int format

setID

public void setID(java.lang.String inId)
sets id for the Transaction Set

Parameters:
inId - String transation set id

setName

public void setName(java.lang.String inName)
sets name for the Transaction Set

Parameters:
inName - String transaction set name

setRevision

public void setRevision(java.lang.String inRevision)
sets Revision for the Transaction Set

Parameters:
inRevision - String revision or version

setFunctionalGroup

public void setFunctionalGroup(java.lang.String inFunctionalGroup)
sets Function Group for the Transaction Set

Parameters:
inFunctionalGroup - String functional group

setShortDescription

public void setShortDescription(java.lang.String inDesc)
sets Short Description for the Transaction Set

Parameters:
inDesc - String description

setHeaderTemplateTable

public void setHeaderTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
sets header TemplateTable for the Transaction Set

Parameters:
inTemplateTable - TemplateTable

setDetailTemplateTable

public void setDetailTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
sets detail TemplateTable for the Transaction Set

Parameters:
inTemplateTable - TemplateTable

setSummaryTemplateTable

public void setSummaryTemplateTable(com.americancoders.edi.TemplateTable inTemplateTable)
sets summary TemplateTable for the Transaction Set

Parameters:
inTemplateTable - TemplateTable

getFormat

public int getFormat()
returns the Transaction Set format

Returns:
int

getID

public java.lang.String getID()
returns the Transaction Set id

Specified by:
getID in interface IIdentifier
Returns:
String

getName

public java.lang.String getName()
returns name for the Transaction Set

Returns:
String

getRevision

public java.lang.String getRevision()
returns revision value for the Transaction Set

Returns:
String

getFunctionalGroup

public java.lang.String getFunctionalGroup()
returns functional group string

Returns:
String

getShortDescription

public java.lang.String getShortDescription()
returns the Short Description for the Transaction Set

Returns:
String

getHeaderTemplateTable

public com.americancoders.edi.TemplateTable getHeaderTemplateTable()
returns header TemplateTable for the Transaction Set

Returns:
TemplateTable

getDetailTemplateTable

public com.americancoders.edi.TemplateTable getDetailTemplateTable()
returns detail TemplateTable for the Transaction Set

Returns:
TemplateTable

getSummaryTemplateTable

public com.americancoders.edi.TemplateTable getSummaryTemplateTable()
returns summary TemplateTable for the Transaction Set

Returns:
TemplateTable

setXMLTag

public void setXMLTag(java.lang.String inXMLTag)
sets the xml tag field

Parameters:
inXMLTag - String xml tag id

getXMLTag

public java.lang.String getXMLTag()
returns the xml tag field

Specified by:
getXMLTag in interface IIdentifier
Returns:
String tag value

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

addIDListFile

public void addIDListFile(java.io.File inFile)

checkIDListFiles

public boolean checkIDListFiles()

getKnownDataElement

public java.util.Hashtable getKnownDataElement()

getKnownComposites

public java.util.Hashtable getKnownComposites()

getKnownSegments

public java.util.Hashtable getKnownSegments()

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.