Package com.ptc.windchill.esi.navigationcriteria

Class ESINavigationCriteriaRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.rnd.NavigationCriteriaAssociatedObjectRenderer

com.ptc.windchill.esi.navigationcriteria.ESINavigationCriteriaRenderer

All Implemented Interfaces:

ESIRenderer

public class ESINavigationCriteriaRenderer
extends NavigationCriteriaAssociatedObjectRenderer

Supported API: true

Extendable: true

Field Summary

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

atoNavigationFilter, comparisonOperatorIdToDisplayMap, deletedNavigationCriterias, EQUAL_DISPLAY, EQUAL_ID, GREATER_THAN_DISPLAY, GREATER_THAN_ID, GREATER_THAN_OR_EQUAL_DISPLAY, GREATER_THAN_OR_EQUAL_ID, groupName, LESS_THAN_DISPLAY, LESS_THAN_ID, LESS_THAN_OR_EQUAL_DISPLAY, LESS_THAN_OR_EQUAL_ID, navCriteria, NOT_EQUAL_DISPLAY, NOT_EQUAL_ID, NOT_SET_ID, part, smartCollection, targets, taskUri

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	adjustConfigSpecElement(com.infoengine.object.factory.Element element, Persistable context, String groupName, WTPartConfigSpec partConfigSpec, Collection<ESITarget> targets, String standardConfigSpecId)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
com.infoengine.object.factory.Element	adjustDeletedNavigationCriteriaElement(String groupName, com.infoengine.object.factory.Element navigationCriteriaElement, Collection<ESITarget> targets, String navCriteriaString, String navCriteriaObjectID, WTPart contextPart)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected com.infoengine.object.factory.Element	adjustNavigationCriteriaElement(com.infoengine.object.factory.Element element, String groupName, NavigationCriteria navCriteria, Collection<ESITarget> targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Output generator for the class.
void	getAllNavigationCriterias(Collection<NavigationCriteria> navigationCriterias, Map<ESIReleasedObjectSnapshot,Map<ESIReleasedObjectAttributes,NavigationCriteria>> prevPublishedNCs, Map<ESIReleasedObjectSnapshot,ESIReleasedObjectAttributes> deletedNavigationCriterias, Collection<ESITarget> targets, String auth, VdbBuilder vdbBuilder, AccountabilityMap accMap)	Renders the all smart collection navigation criterias.
protected void	validate()	Make sure the object is ready to process.

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

createComparisonMap, getATONavCriteriaFilter, getCurrentNavCriterias, getNavCriteria, getNavCriteriaFilters, getPreviousNavCriteriasMap, setATONavigationFilter, setdata, setData, setNavCriteria, setNavigationCriteriaIdAttribute

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

getAllNavigationCriterias

public void getAllNavigationCriterias(Collection<NavigationCriteria> navigationCriterias,
 Map<ESIReleasedObjectSnapshot,Map<ESIReleasedObjectAttributes,NavigationCriteria>> prevPublishedNCs,
 Map<ESIReleasedObjectSnapshot,ESIReleasedObjectAttributes> deletedNavigationCriterias,
 Collection<ESITarget> targets,
 String auth,
 VdbBuilder vdbBuilder,
 AccountabilityMap accMap)
                               throws WTException

Renders the all smart collection navigation criterias. *

Supported API: true

Parameters:

prevPublishedNCs - - A collection of previously published navigation criteris objects.

targets - - A collection of associated ESI targets.

auth - - This parameter contains authentication information required for executing certain Windchill adapter

vdbBuilder - - The VdbBuilder to use when creating output.

navCriterias - - A collection of NavigationCritera objects for which filter information has to be rendered

Throws:

WTException

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Output generator for the class. Does the following:

1. Obtains a list of current and previously published navigation criteria.
2. Identifies if the navigation criteria was previously published and renders in respective group in ESI response.
3. Calls renderNavigationCriteriasAndAssociations().


Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustNavigationCriteriaElement

protected com.infoengine.object.factory.Element adjustNavigationCriteriaElement(com.infoengine.object.factory.Element element,
 String groupName,
 NavigationCriteria navCriteria,
 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.

navCriteria - - The NavigationCriteria that is being processed.

targets - - The collection of ESITarget objects.

Returns:

updated element.

adjustDeletedNavigationCriteriaElement

public com.infoengine.object.factory.Element adjustDeletedNavigationCriteriaElement(String groupName,
 com.infoengine.object.factory.Element navigationCriteriaElement,
 Collection<ESITarget> targets,
 String navCriteriaString,
 String navCriteriaObjectID,
 WTPart contextPart)

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:

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

navigationCriteriaElement - - The element to be updated.

targets - - The collection of ESITarget objects.

navCriteriaString - - String object for navigation criteria information.

navCriteriaObjectID - - The NavigationCriteria object id.

contextPart - - Associated context part.

Returns:

updated navigationCriteriaElement.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

adjustConfigSpecElement

protected com.infoengine.object.factory.Element adjustConfigSpecElement(com.infoengine.object.factory.Element element,
 Persistable context,
 String groupName,
 WTPartConfigSpec partConfigSpec,
 Collection<ESITarget> targets,
 String standardConfigSpecId)

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.

context - - Persistable object in the context of which this configSPec information has to rendered.

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

partConfigSpec - - The WTPartConfigSpec that is being processed.

targets - - The collection of ESITarget objects.

standardConfigSpecId - - WTPartConfigSpec object id.

Returns:

updated element.

validate

protected void validate()
                 throws ESIRendererException

Make sure the object is ready to process. If navigation criterias, authentication, or adapterName are null, throws an exception.

Supported API: true

Overrides:

validate in class NavigationCriteriaAssociatedObjectRenderer

Throws:

ESIRendererException