Package com.ptc.windchill.esi.mpml.processplan

Class ESIProcessPlanLocalizationLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.ESIProcessPlanLocalizationLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIProcessPlanLocalizationLinkRenderer
extends BasicESIRenderer

Renders the output of MPMProcessPlanLocalizationLink (i.e. <ProcessPlanLocalizationLink> </ProcessPlanLocalizationLink>) in ESI Response.

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 groupName, MPMProcessPlanLocalizationLink link, MPMProcessPlan processPlan, MPMWorkCenter workCenter, Collection<ESITarget> targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Renders MPMProcessPlanLocalizationLink objects that are associated with the input process plan as added objects always.
void	setData(MPMProcessPlan processPlan, Collection<ESITargetAssociation> targetAssocs, String auth, String wcAdapter)	Set this renderer's member variables that are necessary for rendering process plan localization links i.e.
protected void	validate()	Validates the attributes which are required for this renderer to execute properly.
protected void	validateProcessPlanLocalizationLinkAssociation(Map<MPMProcessPlanLocalizationLink,MPMWorkCenter> localizationLinkToWCMap)	Validates process plan localization link association.

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

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders MPMProcessPlanLocalizationLink objects that are associated with the input process plan as added objects always. Invokes the API getMPMProcessPlanLocalizationLinks() to fetch localization links and corresponding work centers.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

See Also:

• BasicESIRenderer.buildGroups()

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String groupName,
 MPMProcessPlanLocalizationLink link,
 MPMProcessPlan processPlan,
 MPMWorkCenter workCenter,
 Collection<ESITarget> targets)

Allow subclasses to fix the contents of an element before it's 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.

link - - Link between process plan master and work center's iteration.

processPlan - - process plan whose master is RoleB for the input process plan localization link.

workCenter - - Work center which is RoleA for the input link.

targets - - Collection targets.

Returns:

Updated element.

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(MPMProcessPlan processPlan,
 Collection<ESITargetAssociation> targetAssocs,
 String auth,
 String wcAdapter)
             throws ESIRendererException

Set this renderer's member variables that are necessary for rendering process plan localization links i.e. MPMProcessPlanLocalizationLink.

Supported API: true

Parameters:

processPlan - - Process plan whose localization links need to be rendered.

targetAssocs - - Collection of target assignments with the input process plan.

auth - - Info*Engine authentication information to be used when invoking a query task.

wcAdapter - - Windchill adapter instance name to be used when executing a info*engine webject.

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

validateProcessPlanLocalizationLinkAssociation

protected void validateProcessPlanLocalizationLinkAssociation(Map<MPMProcessPlanLocalizationLink,MPMWorkCenter> localizationLinkToWCMap)
                                                       throws ESIRendererException

Validates process plan localization link association. Override this API to have custom logic for validation or to ignore validation.

Supported API: true

Parameters:

localizationLinkToWCMap - - A Map containing MPMProcessPlanLocalizationLink as a key and corresponding MPMWorkCenter object as the value.

Throws:

ESIRendererException - - When validation fails.