Package com.ptc.windchill.associativity.reconciliation

Class DefaultReconciliationDelegate

java.lang.Object

com.ptc.windchill.associativity.reconciliation.AbstractDiscrepancyProcessor

com.ptc.windchill.associativity.reconciliation.DefaultReconciliationDelegate

All Implemented Interfaces:

ReconciliationDelegate

public class DefaultReconciliationDelegate
extends AbstractDiscrepancyProcessor
implements ReconciliationDelegate

The delegate is to extend to define custom logic for the overall flow of detect and resolve discrepancies.

Supported API: true

Extendable: true

Nested Class Summary

Nested classes/interfaces inherited from class com.ptc.windchill.associativity.reconciliation.AbstractDiscrepancyProcessor

AbstractDiscrepancyProcessor.ConsumptionData

Field Summary

Fields inherited from class com.ptc.windchill.associativity.reconciliation.AbstractDiscrepancyProcessor

BASE_SERVICE_LOCATOR, containerRef, DISCREPANCY_RESOURCE, EMPTY_STRING, EQUIVALENCE_CACHE, EQUIVALENTPART_CACHE, FIRST_LEVEL_EQUIVALENCE_PATHS, MAPSB_PARAM_COPY_OVER_CONTEXT, OCCURRENCE_PATH_CACHE, OTHERSIDE_OCC_PATH_CACHE, OTHERSIDE_USAGE_PATH_CACHE, RESOURCE, UPSTREAM_OCCURRENCE_CACHE

Method Summary

Modifier and Type	Method	Description
boolean	areValuesEqual(String configuredValue, Object persistedValue, Object referenceValue, boolean considerReferenceValue, String rangeDelimiter)	OOTB does string compare and can be overridden to have custom comparison logic.
String	getLocalRules(ReconciliationContext context, AddUsageDiscrepancy discrepancy)	Returns GDS rules as a JSON string from the discrepancy Supported API: true
ReconciliationReport	getReportInstance()	Supported API: true
protected void	handleAutoCheckin(ReconciliationContext context, ReconciliationReport report)	Hook to override auto-checkin behaviour.
Collection<DiscrepancyType>	orderDiscrepancyTypes(Collection<DiscrepancyType> types)	Supported API: true
void	populateChangeItemsFromChange(ReconciliationContext context)	Supported API: true
void	populateChangeItemsFromChange(ReconciliationContext context, Collection<DiscrepancyType> types)	Supported API: true
ReconciliationReport	postDetect(ReconciliationContext context, ReconciliationReport report)	Supported API: true
ReconciliationReport	postResolve(ReconciliationContext context, ReconciliationReport report)	Supported API: true
ReconciliationReport	preDetect(ReconciliationContext context)	Supported API: true
<T extends Discrepancy2> void	preResolve(ReconciliationContext context, Collection<T> discrepancies)	Supported API: true

Methods inherited from class com.ptc.windchill.associativity.reconciliation.AbstractDiscrepancyProcessor

areEqual, checkoutAndHandleReplacements, createUsageLinkAndGetAssociativePath, doConsumptionAnalysis, fetchAndCacheDownstreamEquivalenceLinks, fetchEquivalenceLinks, fetchEquivalentParts, filterConsumedPaths, filterDownEquivalents, getAllOccurrences, getAllSplitDownEquivalentContextMasters, getAssembleToOrderDAO, getAssociativeDAO, getBomService, getChildrenInfo, getClassificationAttributeDAO, getCopyOverContext, getCopyOverDelegateFactory, getCurrentToOldChangeItems, getDescriptorFactory, getDiscrepancyDelegate, getDiscrepantConsumedOccPaths, getDiscrepantConsumedUsagePaths, getDiscrepantConsumedUsagePaths, getDownConsumedPath, getDownstreamEquivalentContextMasters, getEffectivityDAO, getEquivalenceDAO, getEquivalenceManager, getExpressionService, getFactory, getFilteredDownstreamEquivalent, getFilteredDownstreamEquivalents, getFirstLevelEquivalentPaths, getIteratedDAO, getLocalizedMessage, getLocalizer, getNavCriteriaDAO, getOccurrenceManager, getParentAssociative, getPartDAO, getPartPathManager, getPathManager, getPersistableDAO, getPropertiesParser, getResolutionOption, getUpdateQuantityService, getUsagePathLinkManager, hasEquivalenceAnnotation, isAlternateDiscpreancy, isCheckedOutToAnotherUser, isProcessed, isSamePath, populateEquivalenceConsumptionData, populateImpactedUsageConsumptionData, populateOccurrenceConsumptionData, populateTypeInstances, populateUsageConsumptionData, setDownstreamEquivalentAssociativesToContext, updateAssociativePath

Methods inherited from class java.lang.Object

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

Method Details

preDetect

public ReconciliationReport preDetect(ReconciliationContext context)
                               throws WTException

Supported API: true

Specified by:

preDetect in interface ReconciliationDelegate

Parameters:

context -

Returns:

Throws:

WTException

postDetect

public ReconciliationReport postDetect(ReconciliationContext context,
 ReconciliationReport report)
                                throws WTException

Supported API: true

Specified by:

postDetect in interface ReconciliationDelegate

Parameters:

context -

report -

Returns:

Throws:

WTException

getReportInstance

public ReconciliationReport getReportInstance()

Supported API: true

Specified by:

getReportInstance in interface ReconciliationDelegate

Returns:

postResolve

public ReconciliationReport postResolve(ReconciliationContext context,
 ReconciliationReport report)
                                 throws WTException

Supported API: true

Specified by:

postResolve in interface ReconciliationDelegate

Parameters:

context -

report -

Returns:

Throws:

WTException

handleAutoCheckin

protected void handleAutoCheckin(ReconciliationContext context,
 ReconciliationReport report)
                          throws WTException

Hook to override auto-checkin behaviour. This is called via postResolve(ReconciliationContext, ReconciliationReport) if AbstractReconciliationContext.isAutoCheckInEnabled() is true

Supported API: true

Parameters:

context -

report -

Throws:

WTException

preResolve

public <T extends Discrepancy2> void preResolve(ReconciliationContext context,
 Collection<T> discrepancies)
                                         throws WTException

Supported API: true

Specified by:

preResolve in interface ReconciliationDelegate

Parameters:

context - ReconciliationContext

Throws:

WTException

orderDiscrepancyTypes

public Collection<DiscrepancyType> orderDiscrepancyTypes(Collection<DiscrepancyType> types)
                                                  throws WTException

Supported API: true

Specified by:

orderDiscrepancyTypes in interface ReconciliationDelegate

Parameters:

types -

Returns:

Throws:

WTException

populateChangeItemsFromChange

public void populateChangeItemsFromChange(ReconciliationContext context)
                                   throws WTException

Supported API: true

Specified by:

populateChangeItemsFromChange in interface ReconciliationDelegate

Parameters:

context -

Throws:

WTException

populateChangeItemsFromChange

public void populateChangeItemsFromChange(ReconciliationContext context,
 Collection<DiscrepancyType> types)
                                   throws WTException

Supported API: true

Specified by:

populateChangeItemsFromChange in interface ReconciliationDelegate

Parameters:

context -

Throws:

WTException

getLocalRules

public String getLocalRules(ReconciliationContext context,
 AddUsageDiscrepancy discrepancy)
                     throws WTException

Returns GDS rules as a JSON string from the discrepancy Supported API: true

Specified by:

getLocalRules in interface ReconciliationDelegate

Throws:

WTException

areValuesEqual

public boolean areValuesEqual(String configuredValue,
 Object persistedValue,
 Object referenceValue,
 boolean considerReferenceValue,
 String rangeDelimiter)
                       throws WTException

OOTB does string compare and can be overridden to have custom comparison logic. If the configured value is null/empty and persisted value is null as well, we treat them equal. If both are not null, then we do string compare with ignore case and return result else return false.

Supported API: true

Specified by:

areValuesEqual in interface ReconciliationDelegate

Parameters:

configuredValue - - string format value read from configuration for a given attribute

persistedValue - - the persisted value from the database for a given attribute.

referenceValue - - a value with which persisted value should be compared in case no value is configured, typically upstream value

considerReferenceValue - - this flag is needed as no way to know if referenceValue is null or not asked to compare

rangeDelimiter - - delimiter to understand if the value is a range

Returns:

Throws:

WTException