Package com.ptc.windchill.esi.esipart

Class ESIPart

java.lang.Object

com.ptc.windchill.esi.esipart.ESIAbstractPart

com.ptc.windchill.esi.esipart.ESIPart

public class ESIPart
extends ESIAbstractPart

Wraps a WTPart and maintains useful relationships for the benefit of a part renderer.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
Collection<WTPartAlternateLink>	getAlternateLinks()	Gets the object for the association that plays role: alternateLinks.
Collection<WTPart>	getAlternates()	Gets the resolved iterations of object for the association that plays role: alternates.
QueryResult	getPartInfo(WTPart part, NavigationCriteria navCriteria)	Fetches the master for the input part and obtains all the associated alternate parts and alternate links.
protected void	initialize(String ufid)	Obtains the WTPart object identified by the ufid argument and stores it in the current attribute.
static ESIPart	newESIPart(String ufid)	Create an instance of ESIPart, given the UFID of a part.
protected void	setAlternateLinks(Collection<WTPartAlternateLink> a_AlternateLinks)	Sets the object for the association that plays role: alternateLinks.
void	setAlternates(Collection<WTPart> a_Alternates)	Sets the resolved iterations of object for the association that plays role: alternates.

Methods inherited from class com.ptc.windchill.esi.esipart.ESIAbstractPart

getCurrent, getMaster, getPrevious, getTargets, setCurrent, setPrevious, setTargets

Methods inherited from class java.lang.Object

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

Method Details

getAlternates

public Collection<WTPart> getAlternates()

Gets the resolved iterations of object for the association that plays role: alternates.

Supported API: true

Returns:

Collection

setAlternates

public void setAlternates(Collection<WTPart> a_Alternates)

Sets the resolved iterations of object for the association that plays role: alternates.

Supported API: true

Parameters:

a_Alternates -

getAlternateLinks

public Collection<WTPartAlternateLink> getAlternateLinks()

Gets the object for the association that plays role: alternateLinks.

Supported API: true

Returns:

Collection

setAlternateLinks

protected void setAlternateLinks(Collection<WTPartAlternateLink> a_AlternateLinks)

Sets the object for the association that plays role: alternateLinks.

Supported API: true

Parameters:

a_AlternateLinks -

newESIPart

public static ESIPart newESIPart(String ufid)
                          throws WTException,
WTPropertyVetoException

Create an instance of ESIPart, given the UFID of a part.

Supported API: true

Parameters:

ufid -

Returns:

ESIPart

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(String ufid)
                   throws WTException,
WTPropertyVetoException

Obtains the WTPart object identified by the ufid argument and stores it in the current attribute.

Supported API: true

Parameters:

ufid - - UFID of a WTPart.

Throws:

WTException

WTPropertyVetoException

getPartInfo

public QueryResult getPartInfo(WTPart part,
 NavigationCriteria navCriteria)
                        throws WTException

Fetches the master for the input part and obtains all the associated alternate parts and alternate links. Stores the alternate parts in the alternates collection and the links in the alternateLinks collection. This method differs from the other versions in that it invokes the getPartIteration() API of ESIPartUtility that takes in a NavigationCriteria object.

Supported API: true

Parameters:

part - - Part for which to fetch the alternates information.

navCriteria - - NavigationCriteria object to pass in to the ESIPartUtility API that fetches part iterations for a given collection of masters.

Returns:

QueryResult Holds the alternate part master objects associated with the input part.

Throws:

WTException