com.ptc.windchill.cadx.common.util
Interface CADDocSpecs

All Known Implementing Classes:

CADDS5DocSpec, CATIAV4DocSpec, GeneralDocSpec, ICubedDocSpec, PROEDocSpec

public interface CADDocSpecs

Supported API: false

Extendable: false

Method Summary

boolean	doesModelNameContainValidCharacters(String modelName, String modelType) checks whether the user entered valid CAD model name Supported API: false
boolean	doesModelNameExistInWorkspace(EPMWorkspace wsObj, String modelName) Checks whether any EPM document in the workspace has the given model name.
int	getModelNamesMaxSize() Supported API: false
int	getNamesMaxSize() Supported API: false
int	getNumbersMaxSize() Supported API: false
String	getPrefFileSectionName() Returns name of the section in datasource file for a CAD document.
boolean	isFileNameChangeable(EPMDocument epmDocument)
boolean	isModelExtensionValid(String modelName, String modelType) Validate extension (.prt, .asm etc.) as specified in this model name.
boolean	isModelNameSizeValid(String modelName) Validate the size of the model name as for some of the documents (e.g.
boolean	isNameChangeable(EPMDocument epmDocument)
boolean	isNameSizeValid(String name) Validate the size of the document name.
boolean	isNumberChangeable(EPMDocument epmDocument)
boolean	isNumberSizeValid(String number) Validate the size of the document number.
String	validModelExtensions(String modelType) Supported API: false

Method Detail

isModelNameSizeValid

public boolean isModelNameSizeValid(String modelName)

Validate the size of the model name as for some of the documents (e.g. PRO/E component, the size of the name (excluding any extension) is limited due to some constraint by the CAD application.

Supported API: false

Parameters:

modelName -

Returns:

boolean

doesModelNameContainValidCharacters

public boolean doesModelNameContainValidCharacters(String modelName,
                                                   String modelType)

checks whether the user entered valid CAD model name

Supported API: false

Parameters:

modelName -

modelType -

Returns:

boolean

getModelNamesMaxSize

public int getModelNamesMaxSize()

Supported API: false

Returns:

int

isModelExtensionValid

public boolean isModelExtensionValid(String modelName,
                                     String modelType)

Validate extension (.prt, .asm etc.) as specified in this model name. The model file name is allowed to have certain valid extensions. Hence the extension needs to be checked here (for the document number). The valid extensions are specified in the configuration (.ini) file for a specified document type.

Supported API: false

Parameters:

modelName -

modelType -

Returns:

boolean

validModelExtensions

public String validModelExtensions(String modelType)

Supported API: false

Parameters:

modelType -

Returns:

String

isNameSizeValid

public boolean isNameSizeValid(String name)

Validate the size of the document name.

Supported API: false

Parameters:

name -

Returns:

boolean

getNamesMaxSize

public int getNamesMaxSize()

Supported API: false

Returns:

int

isNumberSizeValid

public boolean isNumberSizeValid(String number)

Validate the size of the document number.

Supported API: false

Parameters:

number -

Returns:

boolean

getNumbersMaxSize

public int getNumbersMaxSize()

Supported API: false

Returns:

int

getPrefFileSectionName

public String getPrefFileSectionName()

Returns name of the section in datasource file for a CAD document.

Supported API: false

Returns:

String

doesModelNameExistInWorkspace

public boolean doesModelNameExistInWorkspace(EPMWorkspace wsObj,
                                             String modelName)
                                      throws WTException

Checks whether any EPM document in the workspace has the given model name.

Supported API: false

Parameters:

wsObj -

modelName -

Returns:

boolean

Throws:

WTException

isNumberChangeable

public boolean isNumberChangeable(EPMDocument epmDocument)
                           throws WTException

Throws:

WTException

isNameChangeable

public boolean isNameChangeable(EPMDocument epmDocument)
                         throws WTException

Throws:

WTException

isFileNameChangeable

public boolean isFileNameChangeable(EPMDocument epmDocument)
                             throws WTException

Throws:

WTException