Package com.ptc.windchill.esi.mpml.productionVersion

Class ESIProductionVersionRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.productionVersion.ESIProductionVersionRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIProductionVersionRenderer
extends BasicESIRenderer

This class renders the output of production version which includes production version assignment link.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

adapterName, authentication, currentTarget, DELIMITER, objectTypeDefs, OPTIONSVARIANTS_HELPER_CLASS_STRING, SEPARATOR, taskHelper, XML_META_NAME

Method Summary

Modifier and Type	Method	Description
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, wt.mpm.routing.WCRoutingPlan wcRoutingPlan, Collection<ESITarget> targets)	Allows subclasses to fix the contents of the input Element before it is added to the output group(s).
protected Map<wt.mpm.routing.WCRoutingPlan,ESITargetAssociation>	getPreviousExportedIterationTgtAssociations(Collection<ESITargetAssociation> currentProcessPlanTgtAssociations)	Computes the previous exported iteration for the input target associations.
com.infoengine.object.IeCollection	getProductionVersion(String objectID, ESITransaction txn, Collection<ESITarget> tgts, String auth, String wcAdapter)	Creates a VdbBuilder instance for the input transaction, renders the input productionVersion and creates release activities as appropriate for each of the distribution targets in tgts.
void	setData(String obid, String auth, String wcAdapter)	Initializes this renderer instance appropriately.

Methods inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

addAtt, adjustConfigurableAndCollapsibleAtts, adjustDateEffCxt, adjustDateEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildUfidString, evaluateBussinessRule, fetchLatestEffectivities, formatDateEffectivityElement, getAdapterName, getAssignedVariantSpec, getAssignedVariantSpec, getAUMRenderer, getAuth, getBuilder, getEffectivityElementMap, getEffectivityHandler, getEffectivityTargetAttributes, getElements, getERPMaterialAttributeList, getERPMaterialAttributeList, getERPMaterialTargetAttributes, getFormatedDate, getGroupInfo, getGroupInfo, getGroupInfo, getMap, getMap, getMapInfo, getMapInfo, getMapInfo, getNavigationFilter, getObjectTypeDefs, getPlantSpecificAttributeList, getPlantSpecificAttributeList, getPlantSpecificTargetAttributes, getPreviousObject, getPreviousPublishedEffectivity, getTargetsFromAssns, getTargetUtility, getTransactionUtility, getUnwantedAttributes, getVersionRefObjectRefMap, getWCAttributeList, getWCAttributeList, initEffectivityHandler, initializeElementForGroup, invokeQueryTask, invokeQueryTask, invokeQueryTask, invokeQueryTaskForObjects, isExpressionToBePublished, isGroupAvailable, isPublishAssocOptionSetFlagEnabled, mapDateEffectivities, mapEffectivities, mapEffectivityAttributes, mapEffectivityElement, mapEffectivityParentElement, mapElement, mapElement, mapElement, mapElementWithEffectivityAttrs, mapLotNumberEffectivities, mapObject, mapObject, mapSerialNumberEffectivities, mergeElements, overrideAttrValue, populateDateEffectivityInfo, populateEffectivityInfo, processBussinessRulesWithAnd, processBussinessRuleValidationResultSet, processNoMatchingVersionFound, removeAttributesNotRequired, removeUnwantedEffectivityAttributes, render, renderAssociatedSkinnyVariantSpec, renderAssociatedVariantSpec, renderAssocOptionSetLinks, renderAssocSkinnyVariantSpec, renderAssocVariantSpec, renderATONavigationFilter, renderChoiceRules, renderEffectivities, renderEffectivities, renderExpressions, renderOptionSets, renderRoleBObjectOfModuleVariantLink, setAttrValue, setAttrValue, setAttrValues, setBuilder, setCurrentTarget, setCurrentTarget, setCurrentTargetFromTgtAssocs, setEffectivityHandler, setObjectTypeDefs, setObjectTypeDefs, setObjectTypeDefsFromObj, setStartEndEffAttr, setTransactionUtility, shallPublishAssocOptionSet, shouldRenderEffectivityElementInPartElement, shouldUseOldEffectivityBehaviour, storeCurrentAndItsPreviousObject, storeCurrentAndItsPreviousObject

Methods inherited from class java.lang.Object

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

Method Details

getProductionVersion

public com.infoengine.object.IeCollection getProductionVersion(String objectID,
 ESITransaction txn,
 Collection<ESITarget> tgts,
 String auth,
 String wcAdapter)
                                                        throws WTException

Creates a VdbBuilder instance for the input transaction, renders the input productionVersion and creates release activities as appropriate for each of the distribution targets in tgts. Returns the rendered output as an Info*Engine collection to the caller.
Supported API: true

Parameters:

objectID - UFID of the production version to be rendered.

txn - ESITransaction object that represents the delivery of data to the distribution targets in tgts; will be null when the method is invoked for the Preview functionality.

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

auth - This parameter contains authentication information required for executing certain Windchill adapter webjects as part of the rendering process.

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

Returns:

Throws:

WTException

setData

public void setData(String obid,
 String auth,
 String wcAdapter)

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

obid - ObjectID of Routing plan

auth - I*E authentication information to use when executing a query task.

wcAdapter - Name of the Windchill adapter instance to use when executing a webject.

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 wt.mpm.routing.WCRoutingPlan wcRoutingPlan,
 Collection<ESITarget> targets)
                                                       throws ESIRendererException

Allows subclasses to fix the contents of the input Element before it is added to the output group(s). Default behavior is to return the input Element itself.

Supported API: true

Parameters:

elem - - Info*Engine Element to be updated.

group - - Logical name of the group to which the Element will be added.

wcRoutingPlan - - WCRoutingPlan being processed.

targets - - Collection of ESITarget objects.

Returns:

Element - Updated Element.

Throws:

ESIRendererException

getPreviousExportedIterationTgtAssociations

protected Map<wt.mpm.routing.WCRoutingPlan,ESITargetAssociation> getPreviousExportedIterationTgtAssociations(Collection<ESITargetAssociation> currentProcessPlanTgtAssociations)
                                                                                                      throws WTException

Computes the previous exported iteration for the input target associations. Invokes the API ESITransactionUtility.latestObjectExport(Collection, ESIPropertyRequest)

Computing a previous exported iteration is target sensitive because each target is not guaranteed to have the same previously exported iteration. For example, a process plan could be associated with target 1, then exported, then associated with target 2, and exported a second time. In the case of the second export, target 1 has a previous exported iteration, while target 2 does not. Therefore, the output map contains a previous exported iteration mapped to collection of targets.

Supported API: true

Parameters:

currentProcessPlanTgtAssociations - - Collection of distribution target associations. Typically the target association between the input production version and current distribution target being processed.

processPlan - - Current process plan being rendered.

Returns:

a map whose key is a previous Exported Iteration and the value is a collection of distribution target associations.

Throws:

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