com.ptc.windchill.cadx.autoassociate
Interface AutoAssociatePartFinderCreator

All Known Implementing Classes:
DefaultAutoAssociatePartFinderCreator, DefaultAutoAssociatePartFinderCreator

public interface AutoAssociatePartFinderCreator



Supported API: true

Extendable: false


Field Summary
static String IS_NEW_PART
          Label for the attribute.
 
Method Summary
 WTPart createNewWTPart(EPMDocument epmDoc, String a_PartNumber, String a_PartName, PartType a_PartType, String folderOID, EPMWorkspace a_CurrentWS, WTOrganization a_org, Source a_source, QuantityUnit a_defaultUnits)
           
 WTPart findOrCreateWTPart(EPMDocument epmDoc, EPMWorkspace workspace)
          This method is used for finding or creating a single WTPart for a selected EPMDocument in a Workspace, if a WTPart is not found in Windchill w.r.t the preference settings it will create one.
 WTPart findWTPart(EPMDocument epmDoc)
          This method finds a part to be associated to a document based on the preference settings specified.
 boolean isIsNewPart()
          Gets the value of the attribute: IS_NEW_PART.
 void setIsNewPart(boolean a_IsNewPart)
          Sets the value of the attribute: IS_NEW_PART.
 

Field Detail

IS_NEW_PART

public static final String IS_NEW_PART
Label for the attribute.

Supported API: false

See Also:
Constant Field Values
Method Detail

isIsNewPart

public boolean isIsNewPart()
Gets the value of the attribute: IS_NEW_PART.

Supported API: false

Returns:
boolean

setIsNewPart

public void setIsNewPart(boolean a_IsNewPart)
                  throws WTPropertyVetoException
Sets the value of the attribute: IS_NEW_PART.

Supported API: false

Parameters:
a_IsNewPart -
Throws:
WTPropertyVetoException

findOrCreateWTPart

public WTPart findOrCreateWTPart(EPMDocument epmDoc,
                                 EPMWorkspace workspace)
                          throws WTException,
                                 WTPropertyVetoException,
                                 VersionControlException,
                                 UniquenessException
This method is used for finding or creating a single WTPart for a selected EPMDocument in a Workspace, if a WTPart is not found in Windchill w.r.t the preference settings it will create one.

Supported API: true

Parameters:
epmDoc -
workspace -
Returns:
WTPart
Throws:
WTException
WTPropertyVetoException
VersionControlException
UniquenessException

findWTPart

public WTPart findWTPart(EPMDocument epmDoc)
                  throws WTException,
                         WTPropertyVetoException,
                         VersionControlException,
                         UniquenessException
This method finds a part to be associated to a document based on the preference settings specified. The user has to specify a preference setting named 'SearchForPartAttribute' in "cfgsiteautoassociate,ini " file. Against this preference setting the user can specify an attribute name (in upper case). The value of this attribute will be partnumber in UPPERCASE by default. A WTPart will be returned to the user by this method.

Supported API: true

Parameters:
epmDoc -
Returns:
WTPart
Throws:
WTException
WTPropertyVetoException
VersionControlException
UniquenessException

createNewWTPart

public WTPart createNewWTPart(EPMDocument epmDoc,
                              String a_PartNumber,
                              String a_PartName,
                              PartType a_PartType,
                              String folderOID,
                              EPMWorkspace a_CurrentWS,
                              WTOrganization a_org,
                              Source a_source,
                              QuantityUnit a_defaultUnits)
                       throws WTException,
                              WTPropertyVetoException,
                              VersionControlException,
                              UniquenessException
Throws:
WTException
WTPropertyVetoException
VersionControlException
UniquenessException