Package wt.esi.doc

Interface ESIDocumentsRendererInterface

All Known Implementing Classes:

ESIDocumentsRenderer, ESIEPMDocumentRenderer

public interface ESIDocumentsRendererInterface

Interface to be implemented by an ESI document renderer, so as to provide the correct renderer for WTDocument or CAD document structure.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
com.infoengine.object.IeCollection	getDocument(String objectID, ESITransactionFacade txn, Collection<? extends ESITargetFacade> targets, Map<? extends ESITargetFacade,Map<String,Object>> paramMap, String auth, String wcAdapter)	This method will call the getDocument method of the appropriate document renderer.

Method Details

getDocument

com.infoengine.object.IeCollection getDocument(String objectID,
 ESITransactionFacade txn,
 Collection<? extends ESITargetFacade> targets,
 Map<? extends ESITargetFacade,Map<String,Object>> paramMap,
 String auth,
 String wcAdapter)
                                        throws WTException

This method will call the getDocument method of the appropriate document renderer.

Supported API: true

Parameters:

objectID - - UFID of the header of the CAD document structure to be rendered.

txn - - ESITransaction object that represents the delivery of data to the distribution targets in targets collection; if null, release activities will not be created.

targets - - Collection of distribution targets that represent a given destination, such as an ERP instance.

paramMap - - Map holding ESITarget objects as keys and certain Maps as values; For example, this map can have follwoing entries for some type of ESI target. ESIEPMDocument_DeltaFlag - Specifies whether or not incremental changes to the CAD document structure need to be calculated; can take a value "true" or "false".

auth - - Authentication information required for executing certain Windchill adapter webjects as part of the rendering process.

wcAdapter - - Name of the Windchill adapter instance.

Returns:

The Info*Engine collection that holds the ESI response.

Throws:

WTException - if any of the invoked methods throws this exception.