com.ptc.windchill.esi.esipart
Class ESIPartUtility

java.lang.Object
  com.ptc.windchill.esi.esipart.ESIPartUtility

public final class ESIPartUtility
extends Object

This class is the public interface to the esipart package. It provides generally useful methods for clients external to the package.

Supported API: true

Extendable: false

Method Summary

com.infoengine.object.IeCollection	getPart(String objectID, boolean alternates, boolean documents, String auth, String wcAdapter, String transactionID) GetPart RPC processor.
void	getPart(WTPart root, Collection children, boolean alternates, boolean documents, String auth, String wcAdapter, VdbBuilder builder) GetPart RPC processor when called from GetBOM or getECN RPC.
Collection	getPartIteration(Collection partMasters, WTPart rootPart) This method will return a collection of ESIMasterPartAssociation objects given a collection part masters.

Methods inherited from class java.lang.Object

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

Method Detail

getPart

public final com.infoengine.object.IeCollection getPart(String objectID,
                                                        boolean alternates,
                                                        boolean documents,
                                                        String auth,
                                                        String wcAdapter,
                                                        String transactionID)
                                                 throws WTException

GetPart RPC processor. Validates arguments then creates a VDBBuilder and a Part Renderer. Passes control to the renderer. Returns the VDBBuilder's VDB.

Supported API: true

Parameters:

objectID - The UFID of the part that is desired.

alternates - true or false. If true, will return alternates parts for the part in question.

documents - true or false. If true, will return the documents for the part in question. If alternates is true, will return the documents for the alternate parts.

auth - This parameter contains authentication information from I*E.

wcAdapter - This parameter contains the name of the Windchill adapter.

transactionID - The transactionID of the ESITransaction associated with this RPC.

Returns:

IeCollection

Throws:

WTException

getPart

public final void getPart(WTPart root,
                          Collection children,
                          boolean alternates,
                          boolean documents,
                          String auth,
                          String wcAdapter,
                          VdbBuilder builder)
                   throws WTException

GetPart RPC processor when called from GetBOM or getECN RPC. Validates arguments then creates a VDBBuilder if one hasn't already been provided. Creates a PartRenderer. Passes control to the renderer. Does not call asVDB() on the renderer because the caller of this method is responsible to do that.

Supported API: true

Parameters:

root - The primary part for the BOM. Needed if target assignments are implicit.

children - A collection of WTParts that are to be released. These parts are presumed to not be the root.

alternates - true or false. If true, will return alternates parts for the part in question.

documents - true or false. If true, will return the documents for the part in question. If alternates is true, will return the documents for the alternate parts.

auth - This parameter contains authentication information from I*E

wcAdapter - This parameter contains the name of the Windchill adapter.

builder -

Throws:

WTException

getPartIteration

public final Collection getPartIteration(Collection partMasters,
                                         WTPart rootPart)
                                  throws WTException

This method will return a collection of ESIMasterPartAssociation objects given a collection part masters. This method will use the configspec to get the iteration that matches the configspec.

Supported API: true

Parameters:

partMasters - Collection of part masters

rootPart -

Returns:

Collection

Throws:

WTException