Package com.ptc.windchill.associativity.reconciliation

Interface ReconciliationService

All Known Implementing Classes:

ReconciliationServiceImpl

public interface ReconciliationService

The service class for detecting and resolving discrepancies between an upstream and downstream structures.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
ReconciliationReport	detectAndResolve(ReconciliationContext context)	This will detect all the configured discrepancies in the xconf and try to resolve all the found discrepancies Internally this will call the detectAndResolve(ReconciliationContext, Collection) for all the configured types Supported API: true
ReconciliationReport	detectAndResolve(ReconciliationContext context, Collection<DiscrepancyType> types)	The main method to do the detect and resolve.
ReconciliationReport	detectAndVerify(ReconciliationContext context)	This will detect all the configured discrepancies in the xconf.
ReconciliationReport	detectAndVerify(ReconciliationContext context, Collection<DiscrepancyType> types)	This will detect and verify all the input discrepancies types Supported API: true
ReconciliationReport	generateDownstream(ReconciliationContext rc)	Variation of generateDownstream(Associative, NavigationCriteria, NavigationCriteria, boolean) where this takes a properly build reconciliation context directly.
ReconciliationReport	generateDownstream(ReconciliationContext rc, Collection<AddUsageDiscrepancy> addDiscrepancies)	Variation of generateDownstream(ReconciliationContext) where this takes a properly build reconciliation context and List of AddUsageDiscrepancies.
ReconciliationReport	generateDownstream(Associative root, NavigationCriteria upnc, NavigationCriteria downnc, boolean doAutoCheckin)	API to allow you to start the downstream generation from a given root node.
ReconciliationReport	generateDownstreamFromTemplate(ReconciliationContext rc, Collection<AddUsageDiscrepancy> addDiscrepancies)	Variation of generateDownstream(ReconciliationContext, Collection<AddUsageDiscrepancy>) where this takes a reconciliation context and List of AddUsageDiscrepancies.
Collection<Discrepancy2>	getDiscrepanciesFromJSON(ReconciliationContext context, String discrepancyJSONArray)	Returns a collection of discrepancies by calling respective delegates for each discrepancy JSON.
String	getJSONFromDiscrepancies(ReconciliationContext context, Collection<Discrepancy2> discrepancies)	Returns a JSON array of discrepancies by calling respective delegates for each discrepancy Supported API: true
<T extends Discrepancy2> ReconciliationReport	verifyAndResolve(ReconciliationContext context, Collection<T> discrepancies)	The main method to resolve a collection of discrepancies.

Method Details

generateDownstream

ReconciliationReport generateDownstream(Associative root,
 NavigationCriteria upnc,
 NavigationCriteria downnc,
 boolean doAutoCheckin)
                                 throws WTException

API to allow you to start the downstream generation from a given root node. This API will directly start from the given node and execute the DiscrepancyType.ADDUSAGE logic. This is different and detectAndResolve(ReconciliationContext) that this API does not do any detection and assumes that caller knows that root is a added node where there is no parent or parent information is not relevant.
Supported API: true

Parameters:

root - - the node from where to start the add template logic.

upnc - - navigation criteria to navigate upstream structure. this is optional and if not provided we get a default nc.

downnc - - navigation criteria to navigate downstream structure. this is optional and if not provided we get a default nc.

doAutoCheckin - - tells if all checked out nodes on downstream structure should be checked-in or not.

Returns:

Throws:

WTException

generateDownstream

ReconciliationReport generateDownstream(ReconciliationContext rc)
                                 throws WTException

Variation of generateDownstream(Associative, NavigationCriteria, NavigationCriteria, boolean) where this takes a properly build reconciliation context directly. Allows caller to put extra data needed for downstream generation and use those in custom resolvers etc.
Supported API: true

Returns:

Throws:

WTException

generateDownstream

ReconciliationReport generateDownstream(ReconciliationContext rc,
 Collection<AddUsageDiscrepancy> addDiscrepancies)
                                 throws WTException

Variation of generateDownstream(ReconciliationContext) where this takes a properly build reconciliation context and List of AddUsageDiscrepancies. Provides ability to peform Generate Downstream Structure with rules and template configuration. TODO: DOcument me
Supported API: true

Returns:

Throws:

WTException

detectAndVerify

ReconciliationReport detectAndVerify(ReconciliationContext context)
                              throws WTException

This will detect all the configured discrepancies in the xconf.
Supported API: true

Parameters:

context - - the context with minimum the changeContext and changeItems

Returns:

Throws:

WTException

detectAndVerify

ReconciliationReport detectAndVerify(ReconciliationContext context,
 Collection<DiscrepancyType> types)
                              throws WTException

This will detect and verify all the input discrepancies types
Supported API: true

Parameters:

context - - the context with minimum the changeContext and changeItems

Returns:

Throws:

WTException

verifyAndResolve

<T extends Discrepancy2> ReconciliationReport verifyAndResolve(ReconciliationContext context,
 Collection<T> discrepancies)
                                                        throws WTException

The main method to resolve a collection of discrepancies.
Supported API: true

Parameters:

context -

discrepancies -

Returns:

Throws:

WTException

detectAndResolve

ReconciliationReport detectAndResolve(ReconciliationContext context)
                               throws WTException

This will detect all the configured discrepancies in the xconf and try to resolve all the found discrepancies Internally this will call the detectAndResolve(ReconciliationContext, Collection) for all the configured types
Supported API: true

Parameters:

context - - the context with minimum the changeContext and changeItems

Returns:

Throws:

WTException

detectAndResolve

ReconciliationReport detectAndResolve(ReconciliationContext context,
 Collection<DiscrepancyType> types)
                               throws WTException

The main method to do the detect and resolve. This internally first calls the detectAndVerify(ReconciliationContext, Collection) and then verifyAndResolve(ReconciliationContext, Collection)
Supported API: true

Parameters:

context -

types -

Returns:

Throws:

WTException

getDiscrepanciesFromJSON

Collection<Discrepancy2> getDiscrepanciesFromJSON(ReconciliationContext context,
 String discrepancyJSONArray)
                                           throws WTException

Returns a collection of discrepancies by calling respective delegates for each discrepancy JSON. Expects input as JSONArray string.
Supported API: true

Parameters:

context - - the context having information for navigation criteria and other common data

discrepancyJSONArray - - the toString of JSONArray

Returns:

- collection of discrepancies having one entry for each discrepancy unless no delegate is found for some discrepancy. no order guarantee is provided.

Throws:

WTException

getJSONFromDiscrepancies

String getJSONFromDiscrepancies(ReconciliationContext context,
 Collection<Discrepancy2> discrepancies)
                         throws WTException

Returns a JSON array of discrepancies by calling respective delegates for each discrepancy
Supported API: true

Parameters:

context - - the context having information for navigation criteria and other common data

discrepancies - - the discrepancies which needs to be converted to JSON. each discrepancy will have one entry in the JSONArray string which is output. No order guarantee is provided but if input is List then it should be ideally in the same order.

Returns:

- toString of JSONArray

Throws:

WTException

generateDownstreamFromTemplate

ReconciliationReport generateDownstreamFromTemplate(ReconciliationContext rc,
 Collection<AddUsageDiscrepancy> addDiscrepancies)
                                             throws WTException

Variation of generateDownstream(ReconciliationContext, Collection<AddUsageDiscrepancy>) where this takes a reconciliation context and List of AddUsageDiscrepancies. Provides ability to perform Generate Downstream Structure with rules and template configuration. This method process reconciliation context for each discrepancy to populate change items and downstream navigation criteria.
Supported API: true

Returns:

Throws:

WTException