Package com.ptc.windchill.designasmsrv.assembly

Class ESRDocumentInfo

java.lang.Object

com.ptc.windchill.designasmsrv.assembly.DocumentInfo

com.ptc.windchill.designasmsrv.assembly.ESRDocumentInfo

public class ESRDocumentInfo
extends com.ptc.windchill.designasmsrv.assembly.DocumentInfo

Helper class contains public get/set methods to configure and store ESRDocInfo settings
to create CAR ESR EPMDocument
Support ESR Template configuration specified in parameters as:
- cad template doc name
- or, as ESR EPMDocument


Supported API: true

Extendable: false

Constructor Summary

Constructors

Constructor	Description
ESRDocumentInfo(String esrCADName, String esrTemplateName, String wtContainerName, String wtOrganizationName)	Constructor Define ESR template from specified esrTemplateName
ESRDocumentInfo(String esrCADName, String esrDocumentNumber, String esrDocumentName, String esrTemplateName, WTContainer container, WTOrganization organization)	Constructor Define ESR template from specified esrTemplateName
ESRDocumentInfo(String esrCADName, String esrDocumentNumber, String esrDocumentName, String esrTemplateName, WTContainer container, WTOrganization organization, String esrTemplateDes)	SPR Task: 7800272 - Added description parameter Constructor Define ESR template from specified esrTemplateName

Method Summary

Modifier and Type	Method	Description
String	getCADName()	Supported API: true
EPMDocument	getESRTemplate()	Supported API: true
String	getESRTemplateName()	Supported API: true
String	getWTContainerName()	Supported API: true
String	getWTOrganizationName()	Supported API: true

Methods inherited from class com.ptc.windchill.designasmsrv.assembly.DocumentInfo

getAutoNumbered, getContainer, getDerivedFromNumber, getDescription, getDocumentName, getDocumentNumber, getIBAs, getLocale, getMasterIBAs, getOrganization, getRemoveCopiedRepresentation, getRevision, getTargetFolder, getTemplate, getTemplateName, getUnitSystem, setAutoNumbered, setDerivedFromNumber, setDescription, setIBAs, setLocale, setMasterIBAs, setRemoveCopiedRepresentation, setRevision, setTargetFolder, setUnitSystem

Methods inherited from class java.lang.Object

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

Constructor Details

ESRDocumentInfo

public ESRDocumentInfo(String esrCADName,
 String esrTemplateName,
 String wtContainerName,
 String wtOrganizationName)

Constructor Define ESR template from specified esrTemplateName

Parameters:

esrCADName - - String, CAD name of CAR ESR EPMDocument, if empty will be derived from design asm cad name with "car" prefix

esrTemplateName - - String, required(with extension) to create new document,
or configured in wt.properties

wtContainerName - - WTContainer name

wtOrganizationName - - WTOrganization name

Supported API: true

ESRDocumentInfo

public ESRDocumentInfo(String esrCADName,
 String esrDocumentNumber,
 String esrDocumentName,
 String esrTemplateName,
 WTContainer container,
 WTOrganization organization)

Constructor Define ESR template from specified esrTemplateName

Parameters:

esrCADName - - String, CAD name of CAR ESR EPMDocument, if empty will be derived from design asm cad name with "car" prefix

esrDocumentNumber - - String, if null, will be generated

esrDocumentName - - String

esrTemplateName - - String, required(with extension) to create new document,
or configured in wt.properties

container - - WTContainer

organization - - WTOrganization

Supported API: true

ESRDocumentInfo

public ESRDocumentInfo(String esrCADName,
 String esrDocumentNumber,
 String esrDocumentName,
 String esrTemplateName,
 WTContainer container,
 WTOrganization organization,
 String esrTemplateDes)

SPR Task: 7800272 - Added description parameter Constructor Define ESR template from specified esrTemplateName

Parameters:

esrCADName - - String, CAD name of CAR ESR EPMDocument, if empty will be derived from design asm cad name with "car" prefix

esrDocumentNumber - - String, if null, will be generated

esrDocumentName - - String

esrTemplateName - - String, required(with extension) to create new document,
or configured in wt.properties

container - - WTContainer

organization - - WTOrganization

esrTemplateDes - - String

Supported API: true

Method Details

getCADName

public String getCADName()

Supported API: true

getESRTemplateName

public String getESRTemplateName()

Supported API: true

getESRTemplate

public EPMDocument getESRTemplate()

Supported API: true

getWTContainerName

public String getWTContainerName()

Supported API: true

getWTOrganizationName

public String getWTOrganizationName()

Supported API: true