Package com.ptc.windchill.esi.ov

Class AssignedOptionSetLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.ov.AssignedOptionSetLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class AssignedOptionSetLinkRenderer
extends BasicESIRenderer

Renders Option Set assignment information for an object being published. Creates and renders the OptionSetAssignmentHistory association using the OptionSet specified.

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 element, String groupName, OptionSetAssignmentHistory optSetAssngHistory, 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 the associatedOptionSetLinks as added or deleted objects based on their release history.
void	setData(Persistable context, OptionSet optionSet, OptionSetAssignable assignedBy, ESITarget target, String auth, String adapter, VdbBuilder builder)	Initializes this renderer instance appropriately.
protected void	validate()	Ensures that the data needed to execute this renderer is passed in correctly.

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

setData

public void setData(Persistable context,
 OptionSet optionSet,
 OptionSetAssignable assignedBy,
 ESITarget target,
 String auth,
 String adapter,
 VdbBuilder builder)

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

context - - Object which is referring to this link (part, process plan etc.).

optionSet - - Option set associated with the link.

target - - Distribution target for which the context object is being processed.

auth - - Authentication information for Info*Engine tasks.

adapter - -Windchill adapter name for Info*Engine tasks.

builder - - The VdbBuilder to use when creating output.

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders the associatedOptionSetLinks as added or deleted objects based on their release history. It does following:

1. Finds the latest published OptionSetAssignmentHistory link for the context object
2. If the link is not published before then creates a new OptionSetAssignmentHistory link between the context object and the option set.
3. If the link is published before, calculates the diff for the links.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
 String groupName,
 OptionSetAssignmentHistory optSetAssngHistory,
 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:

element - - The element to be updated.

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

optSetAssngHistory - - OptionSetAssignmentHistory object for which the element is created.

targets - - Collection of ESITarget objects.

Returns:

- An updated AssignedOptionSetLink element.

validate

protected void validate()
                 throws ESIRendererException

Ensures that the data needed to execute this renderer is passed in correctly.
Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException