com.ptc.windchill.esi.esipart
Interface PartRenderer

All Superinterfaces:

ResponseRenderer

All Known Implementing Classes:

ESIPartRenderer

public interface PartRenderer

extends ResponseRenderer

The PartRenderer interface defines the methods that are available on all ESI part renderer implementation classes.

Supported API: true

Extendable: false

Field Summary

static String

UTILITY Label for the attribute.

Method Summary

ESIPartUtility	getUtility() Gets the object for the association that plays role: UTILITY.
void	initialize() Perform any required initialization processing.
void	setData(WTPart root, Collection parts, boolean buildAlts, boolean buildDocs, String auth, String wcAdapter, String transactionID) Establish the renderer's state so that it can process requests.
void	setUtility(ESIPartUtility a_Utility) Sets the object for the association that plays role: UTILITY.

Methods inherited from interface com.ptc.windchill.esi.rnd.ResponseRenderer

render

Field Detail

UTILITY

public static final String UTILITY

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getUtility

public ESIPartUtility getUtility()

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

Supported API: true

Returns:

ESIPartUtility

setUtility

public void setUtility(ESIPartUtility a_Utility)
                throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Utility -

Throws:

WTPropertyVetoException

setData

public void setData(WTPart root,
                    Collection parts,
                    boolean buildAlts,
                    boolean buildDocs,
                    String auth,
                    String wcAdapter,
                    String transactionID)

Establish the renderer's state so that it can process requests.

Supported API: false

Parameters:

root - The primary part to process. May not be null. If multiple parts are to be processed, the renderer will use the root as the base part for target determination.

parts - A collection of additional parts to process. May be empty.

buildAlts - Are alternates to be returned by the renderer?

buildDocs - Are documents associated with the part to be returned by the renderer?

auth - Info*Engine authorization for invoking a webject.

wcAdapter - Windchill adapter instance to run the webject

transactionID - Optional transaction ID to pass to the VDB builder.

initialize

public void initialize()

Perform any required initialization processing.

Supported API: true