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

Field Summary

protected static String	ADMIN_USER_PROPERTY
private static String	CLASSNAME
private static String	CONFIGSPEC_FILE_NAME
private static String	DEFAULT_CONFIGSPEC
protected static String	NULL_STRING
private static String	RESOURCE
private static String	STATENAME
private ESITargetUtility	targetUtility
private Task	task
private TaskHelper	taskHelper
private ESITransactionUtility	transactionUtility

Constructor Summary

ESIPartUtility()

Method Summary

(package private) Collection	addToCollection(Vector v, WTPart part)
(package private) Collection	findAddedParts(Collection previousParts, Collection currentParts)
(package private) Collection	getAltLinks(Collection partTargetAssoc, Collection alternates)
(package private) Collection	getDeletedAltLinks(Collection curPartAssoc, Collection alts)
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.
(package private) Collection	getTargets(Collection assns)
(package private) Collection	getTargets(Collection addedPartAssociations, WTPart part)
(package private) Collection	getTargetsForParts(Collection parts)
(package private) IeCollection	invokeQueryTask(String taskName, String ufids, String auth, String wcAdapter)

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NULL_STRING

protected static final String NULL_STRING

See Also:

Constant Field Values

ADMIN_USER_PROPERTY

protected static final String ADMIN_USER_PROPERTY

See Also:

Constant Field Values

task

private Task task

transactionUtility

private ESITransactionUtility transactionUtility

targetUtility

private ESITargetUtility targetUtility

taskHelper

private TaskHelper taskHelper

CONFIGSPEC_FILE_NAME

private static final String CONFIGSPEC_FILE_NAME

See Also:

Constant Field Values

DEFAULT_CONFIGSPEC

private static final String DEFAULT_CONFIGSPEC

See Also:

Constant Field Values

STATENAME

private static final String STATENAME

Constructor Detail

ESIPartUtility

public ESIPartUtility()

Method Detail

getPart

public final 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

invokeQueryTask

IeCollection invokeQueryTask(String taskName,
                             String ufids,
                             String auth,
                             String wcAdapter)
                       throws WTException

Throws:

WTException

findAddedParts

Collection findAddedParts(Collection previousParts,
                          Collection currentParts)

getTargetsForParts

Collection getTargetsForParts(Collection parts)
                        throws WTException

Throws:

WTException

addToCollection

Collection addToCollection(Vector v,
                           WTPart part)

getTargets

Collection getTargets(Collection addedPartAssociations,
                      WTPart part)

getTargets

Collection getTargets(Collection assns)

getAltLinks

Collection getAltLinks(Collection partTargetAssoc,
                       Collection alternates)

getDeletedAltLinks

Collection getDeletedAltLinks(Collection curPartAssoc,
                              Collection alts)