Package com.ptc.windchill.esi.esidoc

Class ESIDocUtility

java.lang.Object

com.ptc.windchill.esi.esidoc.ESIDocUtility

public final class ESIDocUtility
extends Object

Supported API: true

Extendable: false

Constructor Summary

Constructors

Constructor	Description
ESIDocUtility(NavigationCriteria navigationCriteria)	Initializes doc utility to sets navigation criteria for used by rendered in doc utility Supported API: true

Method Summary

Modifier and Type	Method	Description
final Collection[]	retrievePartDocDifferences(RevisionControlled currentPart, RevisionControlled previousPart)	Deprecated. Use retrievePartDocDifferences(RevisionControlled, RevisionControlled, ESITarget) instead of this API, ESITarget can be null in this API
final Collection[]	retrievePartDocDifferences(RevisionControlled currentIteration, RevisionControlled previousIteration, ESITarget target)	This method compares the set of WTDocuments and EPMDocuments that are associated with the two given RevisionControlled object iterations and returns an array of Collections.
final Collection[]	retrievePartDocDifferences(RevisionControlled currentIteration, RevisionControlled previousIteration, ESITarget target, boolean isEnterpriseDataMergeWithPart)	This method compares the set of WTDocuments and EPMDocuments that are associated with the two given RevisionControlled object iterations and returns an array of Collections.
final Collection	retrievePartDocInformation(RevisionControlled objectIteration)	Returns a collection of PartDocInfo objects that provide information about the WTDocument and EPMDocument objects associated with the input RevisionControlled object.
final Collection	retrievePartDocInformation(RevisionControlled objectIteration, boolean isEnterpriseDataMergeWithPart)	Returns a collection of PartDocInfo objects that provide information about the WTDocument and EPMDocument objects associated with the input RevisionControlled object.
void	setWorkingIncluded(boolean workingIncluded)	Sets the instance variable workingIncluded to the input value.

Methods inherited from class java.lang.Object

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

Constructor Details

ESIDocUtility

public ESIDocUtility(NavigationCriteria navigationCriteria)

Initializes doc utility to sets navigation criteria for used by rendered in doc utility

Supported API: true

Parameters:

navigationCriteria -

Method Details

retrievePartDocInformation

public final Collection retrievePartDocInformation(RevisionControlled objectIteration)
                                            throws WTException

Returns a collection of PartDocInfo objects that provide information about the WTDocument and EPMDocument objects associated with the input RevisionControlled object.

Supported API: true

Parameters:

objectIteration - RevisionControlled object for which to fetch the required information.

Returns:

Collection of PartDocInfo objects.

Throws:

WTException

retrievePartDocInformation

public final Collection retrievePartDocInformation(RevisionControlled objectIteration,
 boolean isEnterpriseDataMergeWithPart)
                                            throws WTException

Returns a collection of PartDocInfo objects that provide information about the WTDocument and EPMDocument objects associated with the input RevisionControlled object.

Supported API: true

Parameters:

objectIteration - - RevisionControlled object for which to fetch the required information.

isEnterpriseDataMergeWithPart - - Flag that indicates whether enterprise data object is rendered in separate element or merged in part eleement. When value is 'true' then enterprise data object will be rendered in separate eleemnt in part group in response file otherwise enterprise data attributes will be merged with part element.

Returns:

Collection of PartDocInfo objects.

Throws:

WTException

retrievePartDocDifferences

public final Collection[] retrievePartDocDifferences(RevisionControlled currentIteration,
 RevisionControlled previousIteration,
 ESITarget target)
                                              throws WTException

This method compares the set of WTDocuments and EPMDocuments that are associated with the two given RevisionControlled object iterations and returns an array of Collections.

Element 0 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with currentPart but are not associated with previousPart. In the ESI scenario, this would represent the set of documents that have been added to the RevisionControlled object since the last time the object had been sent to ERP.

Element 1 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with previousPart but are not associated with currentPart. In the ESI scenario, this would represent the set of documents that have been deleted from the RevisionControlled object since the last time the object had been sent to ERP.

Element 2 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with both previousPart and currentPart.

Supported API: true

Parameters:

currentIteration - Currently published iteration of the RevisionControlled object.

previousIteration - Previously published iteration of the RevisionControlled object.

target - ESITarget for which publication history is to be checked.

Returns:

Collection[] Array of collections of PartDocInfo objects.

Throws:

WTException

retrievePartDocDifferences

public final Collection[] retrievePartDocDifferences(RevisionControlled currentIteration,
 RevisionControlled previousIteration,
 ESITarget target,
 boolean isEnterpriseDataMergeWithPart)
                                              throws WTException

This method compares the set of WTDocuments and EPMDocuments that are associated with the two given RevisionControlled object iterations and returns an array of Collections.

Element 0 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with currentPart but are not associated with previousPart. In the ESI scenario, this would represent the set of documents that have been added to the RevisionControlled object since the last time the object had been sent to ERP.

Element 1 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with previousPart but are not associated with currentPart. In the ESI scenario, this would represent the set of documents that have been deleted from the RevisionControlled object since the last time the object had been sent to ERP.

Element 2 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with both previousPart and currentPart.

Supported API: true

Parameters:

currentIteration - - Currently published iteration of the RevisionControlled object.

previousIteration - - Previously published iteration of the RevisionControlled object.

target - - ESITarget for which publication history is to be checked.

isEnterpriseDataMergeWithPart - - Flag that indicates whether enterprise data object is rendered in separate element or merged in part element. When value is 'true' then enterprise data object will be rendered in separate element in part group in response file otherwise enterprise data attributes will be merged with part element.

Returns:

Collection[] Array of collections of PartDocInfo objects.

Throws:

WTException

setWorkingIncluded

public void setWorkingIncluded(boolean workingIncluded)

Sets the instance variable workingIncluded to the input value.

Supported API: true

Parameters:

workingIncluded - Value to set the instance variable workingIncluded to.

retrievePartDocDifferences

public final Collection[] retrievePartDocDifferences(RevisionControlled currentPart,
 RevisionControlled previousPart)
                                              throws WTException

Deprecated.

Use retrievePartDocDifferences(RevisionControlled, RevisionControlled, ESITarget) instead of this API, ESITarget can be null in this API

This method compares the set of WTDocuments and EPMDocuments that are associated with the two given RevisionControlled object iterations and returns an array of Collections.

Element 0 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with currentPart but are not associated with previousPart. In the ESI scenario, this would represent the set of documents that have been added to the RevisionControlled object since the last time the object had been sent to ERP.

Element 1 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with previousPart but are not associated with currentPart. In the ESI scenario, this would represent the set of documents that have been deleted from the RevisionControlled object since the last time the object had been sent to ERP.

Element 2 of the array is a Collection of PartDocInfo objects that provide information about the documents that are associated with both previousPart and currentPart.

Supported API: true

Parameters:

currentPart - Currently published iteration of the RevisionControlled object.

previousPart - Previously published iteration of the RevisionControlled object.

Returns:

Collection[] Array of collections of PartDocInfo objects.

Throws:

WTException