com.ptc.edadata
Class BOMRequestItem

java.lang.Object
  extended bycom.ptc.edadata.ExchangeItem
      extended bycom.ptc.edadata.RequestItem
          extended bycom.ptc.edadata.BOMRequestItem

public class BOMRequestItem
extends RequestItem

Title: BOMRequestItem

Description: This object contains all the neccessary information for a particular BOM. Names of columns for part name, number, quantity and reference designator are mandatory

Copyright: Copyright (c) 2004

Company: PTC


Field Summary
private  boolean m_bGetAllVariants
           
private  int m_numUniqueID
           
private  String m_strBOMFile
           
private  String m_strLibraryPath
           
private  String m_strNameColName
           
private  String m_strNumberColName
           
private  String m_strQuantityColName
           
private  String m_strRefDesColname
           
 
Fields inherited from class com.ptc.edadata.RequestItem
 
Constructor Summary
BOMRequestItem()
          Default constructor.
BOMRequestItem(String designRootDir, String ecadType)
           
BOMRequestItem(String designRootDir, String ecadType, String nameColName, String numberColName, String quantityColName, String refDesColName)
           
 
Method Summary
 boolean getAllVariants()
           
 String getBOMFile()
           
 int getID()
           
 String getLibraryPath()
           
 String getNameColName()
          This method will get the name of "Part Name" of BOM
 String getNumberColName()
          This method will get the name of "Part Number" of BOM
 String getQuantityColName()
          This method will get the name of "Quantity" of BOM
 String getRefDesColName()
          This method will get the name of "Reference Designator" of BOM
 RequestType getType()
           
 void setAllVariants(boolean getAllVariants)
           
 void setBOMFile(String bomFile)
           
 void setID(int uniqueID)
           
 void setLibraryPath(String libraryPath)
           
 void setNameColName(String nameColName)
          This method will set the name of "Part Name" of BOM
 void setNumberColName(String numberColName)
          This method will set the name of "Part Number" of BOM
 void setQuantityColName(String quantityColName)
          This method will set the name of "Quantity" of BOM
 void setRefDesColName(String refDesColName)
          This method will set the name of "Reference Designator" of BOM
 
Methods inherited from class com.ptc.edadata.RequestItem
getConduitBinPath, getDesignAppPath, getDesignFile, getDesignRootDir, getEcadType, getInterAppPath, getOutputFilePath, getTempFilePath, setConduitBinPath, setDesignAppPath, setDesignFile, setDesignRootDir, setEcadType, setInterAppPath, setOutputFilePath, setTempFilePath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_strNameColName

private String m_strNameColName

m_strNumberColName

private String m_strNumberColName

m_strQuantityColName

private String m_strQuantityColName

m_strRefDesColname

private String m_strRefDesColname

m_strBOMFile

private String m_strBOMFile

m_strLibraryPath

private String m_strLibraryPath

m_bGetAllVariants

private boolean m_bGetAllVariants

m_numUniqueID

private int m_numUniqueID
Constructor Detail

BOMRequestItem

public BOMRequestItem()
Default constructor.


BOMRequestItem

public BOMRequestItem(String designRootDir,
                      String ecadType)
Parameters:
designRootDir - String of design root directory
ecadType - String of ecad type

BOMRequestItem

public BOMRequestItem(String designRootDir,
                      String ecadType,
                      String nameColName,
                      String numberColName,
                      String quantityColName,
                      String refDesColName)
Parameters:
designRootDir - String of design root directory
ecadType - String of ecad type
nameColName - String of name of "Part Name" on BOM
numberColName - String of name of "Part Number" on BOM
quantityColName - String of name of "Quantity" on BOM
refDesColName - String of name of "Reference Designators" on BOM
Method Detail

getNameColName

public String getNameColName()
This method will get the name of "Part Name" of BOM

Returns:
Actual name of "Part Name" BOM column string as appearing in corresponding BOMColumnDef's name property.

setNameColName

public void setNameColName(String nameColName)
This method will set the name of "Part Name" of BOM

Parameters:
nameColName - String Actual name of "Part Name" BOM column string as appearing in corresponding BOMColumnDef's name property.

getNumberColName

public String getNumberColName()
This method will get the name of "Part Number" of BOM

Returns:
Actual name of "Part Number" BOM column string as appearing in corresponding BOMColumnDef's name property.

setNumberColName

public void setNumberColName(String numberColName)
This method will set the name of "Part Number" of BOM

Parameters:
numberColName - String Actual name of "Part Number" BOM column string as appearing in corresponding BOMColumnDef's name property.

getQuantityColName

public String getQuantityColName()
This method will get the name of "Quantity" of BOM

Returns:
Actual name of "Quantity" BOM column string as appearing in corresponding BOMColumnDef's name property.

setQuantityColName

public void setQuantityColName(String quantityColName)
This method will set the name of "Quantity" of BOM

Parameters:
quantityColName - String Actual name of "Quantity" BOM column string as appearing in corresponding BOMColumnDef's name property.

getRefDesColName

public String getRefDesColName()
This method will get the name of "Reference Designator" of BOM

Returns:
Actual name of "Reference Designators" BOM column string as appearing in corresponding BOMColumnDef's name property.

setRefDesColName

public void setRefDesColName(String refDesColName)
This method will set the name of "Reference Designator" of BOM

Parameters:
refDesColName - String Actual name of "Reference Designators" BOM column string as appearing in corresponding BOMColumnDef's name property.

getBOMFile

public String getBOMFile()

setBOMFile

public void setBOMFile(String bomFile)

setAllVariants

public void setAllVariants(boolean getAllVariants)

getAllVariants

public boolean getAllVariants()

getLibraryPath

public String getLibraryPath()

setLibraryPath

public void setLibraryPath(String libraryPath)

setID

public void setID(int uniqueID)
Specified by:
setID in class ExchangeItem

getID

public int getID()
Specified by:
getID in class ExchangeItem

getType

public RequestType getType()
Specified by:
getType in class RequestItem