Package com.ptc.windchill.esi.mpml.pmi

Class ESIStandardCCLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.pmi.ESIStandardCCLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIStandardCCLinkRenderer
extends BasicESIRenderer

Renders the links MPMPartQualityLink, MPMProcessQualityLink and MPMOperationQualityLink

Supported API: true

Extendable: true

Field Summary

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

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

Method Summary

Modifier and Type	Method	Description
com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, ObjectToObjectLink qualityLink, MPMControlCharacteristic controlCharacteristic, Collection targets)	Allow subclasses to fix the contents of quality link element before it is added to the output group(s).
com.infoengine.object.factory.Element	adjustModelItemElement(com.infoengine.object.factory.Element elem, String groupName, ModelItem modelItem, GraphicData graphicData, MPMControlCharacteristic controlCharacteristic, Collection targets)	Allow subclasses to fix the contents of a model item element before it is added to the output group(s).
protected void	buildGroups()	Renders and populates VDB instance with Quality Links object.
protected boolean	isDocument()	Gets the value of the attribute: document.
protected boolean	isResource()	Gets the value of the attribute: resource.
void	setData(Persistable root, Map[] qualityLinksToCCMaps, String auth, String wcAdapter, VdbBuilder builder)	Sets the state of this renderer appropriately.
protected void	validate()	Validates the attributes which are required for this renderer to execute properly.

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, 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

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders and populates VDB instance with Quality Links object. Delegates the work of difference management to the method buildAGroup(String, Map) to build these groups.
Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustElement

public com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 ObjectToObjectLink qualityLink,
 MPMControlCharacteristic controlCharacteristic,
 Collection targets)
                                                    throws ESIRendererException

Allow subclasses to fix the contents of quality link element before it is added to the output group(s). Default behavior is to return the argument.

Supported API: true

Parameters:

elem - - The element to be updated.

group - - The logical name of the group to which the element will be added.

qualityLink - - Quality link.

controlCharacteristic - - Control characteristic.

targets - - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

adjustModelItemElement

public com.infoengine.object.factory.Element adjustModelItemElement(com.infoengine.object.factory.Element elem,
 String groupName,
 ModelItem modelItem,
 GraphicData graphicData,
 MPMControlCharacteristic controlCharacteristic,
 Collection targets)
                                                             throws ESIRendererException

Allow subclasses to fix the contents of a model item element before it is added to the output group(s). Default behavior is to return the argument.

Supported API: true

Parameters:

elem - - The element to be updated.

groupName - - The logical name of the group to which the element will be added.

modelItem - - Model Item.

graphicData - - GraphicData object which has getter/setter methods to get the data of this model item.

controlCharacteristic - - Associated MPMControlCharacteristic object.

targets - - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

validate

protected void validate()
                 throws ESIRendererException

Validates the attributes which are required for this renderer to execute properly.
Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException

setData

public void setData(Persistable root,
 Map[] qualityLinksToCCMaps,
 String auth,
 String wcAdapter,
 VdbBuilder builder)
             throws WTException

Sets the state of this renderer appropriately.

Supported API: true

Parameters:

qualityLinksToCCMaps - - An array of maps whose keys are the quality links and the values are corresponding control characteristics. index 0 - added quality links, 1- deleted, 2- changed, 3- unchanged and corresponding control characteristics.

auth - - Authentication to be used while fetching the corresponding info engine elements of the control characteristics to be rendered.

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

builder - - VdbBuilder instance to be populated with the response data.

rootb - - A persistable object whose associated Quality Links have to be rendered in to the response. This object can be a Part, process plan or operation.

Throws:

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

isResource

protected boolean isResource()

Gets the value of the attribute: resource.

Supported API: true

Returns:

boolean

isDocument

protected boolean isDocument()

Gets the value of the attribute: document.

Supported API: true

Returns:

boolean