Package com.ptc.windchill.uwgm.cadx.newcaddoc

Class DefaultNewCadAttributesPopulatorDelegate

java.lang.Object

com.ptc.windchill.uwgm.cadx.newcaddoc.DefaultNewCadAttributesPopulatorDelegate

All Implemented Interfaces:

NewCadAttributesPopulatorDelegate

public class DefaultNewCadAttributesPopulatorDelegate
extends Object
implements NewCadAttributesPopulatorDelegate

This is the default implementation for returning attributes in the new cad wizard and the design context wizard.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateRequiredAttributes(TypeIdentifier cadDocTypeIdentifier, Persistable contextObject, WTContainerRef container)	Checks for whether the number has OIR set up to be generated.
com.ptc.windchill.uwgm.aad.AuthAppDescriptor	getAuthAppDescriptor(NmCommandBean commandBean)	Convenience method for use in customizing the filename and name.
String	getFileName(EPMDocument epmDoc, NmCommandBean commandBean)	First it returns either user's explicitly entered number or OIR computed number (in "as is" form without tampering with case) value explictiltyEnteredOrOirComputedNumber if it had been set in clientData.
String	getFileNameLabel(NmCommandBean commandBean)	Returns the cad document label for filename check box.
String	getName(NmCommandBean commandBean)	Returns the Configuration Context name as the name for this Design Context.
String	getNumberCheckboxLabel(NmCommandBean commandBean)	Returns the cad document label for number check box.

Methods inherited from class java.lang.Object

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

Method Details

getFileName

public String getFileName(EPMDocument epmDoc,
 NmCommandBean commandBean)

First it returns either user's explicitly entered number or OIR computed number (in "as is" form without tampering with case) value explictiltyEnteredOrOirComputedNumber if it had been set in clientData. Otherwise returns the cad document number from specified type instance. Note that number in type instance is always uppercased (number attribute is always auto upper cased in EPMDocument) when number is set to it. However, such uppercased number is not what we want to return back as default file name. This is why explictiltyEnteredOrOirComputedNumber value is returned by default.
Supported API: true

Specified by:

getFileName in interface NewCadAttributesPopulatorDelegate

Parameters:

epmDoc - EPMDocument

commandBean - NmCommandBean

Returns:

The string to populate the file name value of the epm document.

getFileNameLabel

public String getFileNameLabel(NmCommandBean commandBean)

Returns the cad document label for filename check box.

Supported API: true

Specified by:

getFileNameLabel in interface NewCadAttributesPopulatorDelegate

Parameters:

commandBean - NmCommandBean

Returns:

The string to populate after the checkbox on the design context wizard.

getName

public String getName(NmCommandBean commandBean)

Returns the Configuration Context name as the name for this Design Context.

Supported API: true

Specified by:

getName in interface NewCadAttributesPopulatorDelegate

Parameters:

commandBean - NmCommandBean

Returns:

String

getAuthAppDescriptor

public com.ptc.windchill.uwgm.aad.AuthAppDescriptor getAuthAppDescriptor(NmCommandBean commandBean)
                                                                  throws Exception

Convenience method for use in customizing the filename and name.

Supported API: true

Throws:

Exception

canGenerateRequiredAttributes

public boolean canGenerateRequiredAttributes(TypeIdentifier cadDocTypeIdentifier,
 Persistable contextObject,
 WTContainerRef container)

Checks for whether the number has OIR set up to be generated.

Supported API: true

Specified by:

canGenerateRequiredAttributes in interface NewCadAttributesPopulatorDelegate

Parameters:

cadDocTypeIdentifier - TypeIdentifier

contextObject - Persistable

container - WTContainerRef

Returns:

boolean

getNumberCheckboxLabel

public String getNumberCheckboxLabel(NmCommandBean commandBean)

Returns the cad document label for number check box.

Specified by:

getNumberCheckboxLabel in interface NewCadAttributesPopulatorDelegate

Parameters:

commandBean -

Returns:

name of number check box label

Supported API: true