com.ptc.edadata
Class RequestItem

java.lang.Object
  com.ptc.edadata.ExchangeItem
      com.ptc.edadata.RequestItem

Direct Known Subclasses:

BoardRequestItem, BOMRequestItem, CleanupRequestItem, ECADTypeRequestItem, EDAViewableRequestItem, FileListRequestItem, SchematicRequestItem, VerifyDesignRequestItem

public abstract class RequestItem

extends ExchangeItem

Title: RequestItem

Description: This is the base class for all request objects.

Copyright: Copyright (c) 2004

Company: PTC

Field Summary

private String	m_conduitBinPath
private String	m_ecadType
private String	m_strDesignAppPath
private String	m_strDesignFile
private String	m_strDesignRootDir
private String	m_strInterAppPath
private String	m_strOutputFilePath
private String	m_strTempFilePath

Constructor Summary

RequestItem()
Default constructor.

RequestItem(String designRootDir, String ecadType)

Method Summary

String	getConduitBinPath()
String	getDesignAppPath()
String	getDesignFile()
String	getDesignRootDir() This method is for getting the root directory for a design.
String	getEcadType() This method will get the eCAD type of request object.
String	getInterAppPath()
String	getOutputFilePath()
String	getTempFilePath()
abstract RequestType	getType()
void	setConduitBinPath(String conduitBinPath)
void	setDesignAppPath(String designAppPath)
void	setDesignFile(String designFile)
void	setDesignRootDir(String designRootDir) This method is for setting the root directory for a design.
void	setEcadType(String ecadType) This method will set the eCAD type of request object.
void	setInterAppPath(String interAppPath)
void	setOutputFilePath(String outputFilePath)
void	setTempFilePath(String edaTempFilePath)

Methods inherited from class com.ptc.edadata.ExchangeItem

getID, setID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_strDesignRootDir

private String m_strDesignRootDir

m_ecadType

private String m_ecadType

m_conduitBinPath

private String m_conduitBinPath

m_strDesignAppPath

private String m_strDesignAppPath

m_strInterAppPath

private String m_strInterAppPath

m_strTempFilePath

private String m_strTempFilePath

m_strDesignFile

private String m_strDesignFile

m_strOutputFilePath

private String m_strOutputFilePath

Constructor Detail

RequestItem

public RequestItem()

Default constructor.

RequestItem

public RequestItem(String designRootDir,
                   String ecadType)

Method Detail

getDesignRootDir

public String getDesignRootDir()

This method is for getting the root directory for a design.

Returns:

Root directory string for a context design.

setDesignRootDir

public void setDesignRootDir(String designRootDir)

This method is for setting the root directory for a design.

getEcadType

public String getEcadType()

This method will get the eCAD type of request object. Null value means that calling code doesn't know it and asks OHIO tool to try to determine it by design dir's contents.
As we plan to be able to handle assemblies having scematic and board designed by different ECADs, both request and response items must have a "ECAD type" attribute

Returns:

ECAD type string of the design.

setEcadType

public void setEcadType(String ecadType)

This method will set the eCAD type of request object.

getConduitBinPath

public String getConduitBinPath()

setConduitBinPath

public void setConduitBinPath(String conduitBinPath)

getDesignAppPath

public String getDesignAppPath()

setDesignAppPath

public void setDesignAppPath(String designAppPath)

getInterAppPath

public String getInterAppPath()

setInterAppPath

public void setInterAppPath(String interAppPath)

getOutputFilePath

public String getOutputFilePath()

setOutputFilePath

public void setOutputFilePath(String outputFilePath)

getTempFilePath

public String getTempFilePath()

setTempFilePath

public void setTempFilePath(String edaTempFilePath)

getDesignFile

public String getDesignFile()

setDesignFile

public void setDesignFile(String designFile)

getType

public abstract RequestType getType()