Package com.ptc.windchill.esi.delegate

Interface InfDocumentQueryDelegate

All Known Implementing Classes:
DocumentQueryDelegate
public interface InfDocumentQueryDelegate
Represents document information identified for export by the retrievePartDocInformation and retrievePartDocDifferences methods of the WTPartService.

Supported API: true

Extendable: true

  • Method Details

    • addReferenceDocPDI

      void addReferenceDocPDI(RevisionControlled part, Hashtable hash, boolean workingIncluded) throws WTException, ConfigException
      Fetches reference document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      part - Input RevisionControlled object for which to fetch reference document associations.
      hash - Input Hashtable to add the created PartDocInfo objects to.
      workingIncluded - Determines whether or not working copies are to be included in the output; this is simply passed in to the initialize() API.
      Throws:
      WTException
      ConfigException

    • addDescribeDocumentPDI

      boolean addDescribeDocumentPDI(RevisionControlled revisionControlled, Hashtable hash, boolean workingIncluded) throws WTException
      Fetches described by document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      revisionControlled - Input RevisionControlled object for which to fetch described by document associations.
      hash - Input Hashtable to add the created PartDocInfo objects to.
      workingIncluded - Determines whether or not working copies are to be included in the output; this is simply passed in to the initialize() API.
      Returns:
      A true, if the input object has at least one CAD document associated to it; a false, otherwise.
      Throws:
      WTException

    • addBuildHistoryPDI

      boolean addBuildHistoryPDI(RevisionControlled revisionControlled, Hashtable hash) throws WTException
      Fetches built by (or BuildHistory) document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      revisionControlled - Input RevisionControlled object for which to fetch BuildHistory document associations.
      hash - Input Hashtable to add the created PartDocInfo objects to.
      Returns:
      return A true, if the input object has at least one CAD document associated to it, via a BuildHistory association; a false, otherwise.
      Throws:
      WTException

    • addCalculatedDrawings

      void addCalculatedDrawings(RevisionControlled rcObj, Hashtable table) throws WTException
      Fetches the calculated drawings for the input RevisionControlled object and adds these to the input Hashtable as appropriate.

      Supported API: true
      Parameters:
      rcObj - RevisionControlled object (such as a WTPart) for which to add calculated drawings.
      table - Hashtable to which to add the calculated drawings. See the Javadoc for getCalculatedDrawings() for more information on its contents.
      Throws:
      WTException - if any of the invoked methods throws an exception.

    • addCalculatedDrawings

      void addCalculatedDrawings(Collection<EPMDocument> dwgs, Hashtable table) throws WTException
      Adds the drawings in the input collection to the input Hashtable as appropriate.

      Supported API: true
      Parameters:
      dwgs - Input collection of calculated drawings.
      table - Hashtable to which to add the drawings. Only those drawings for which an associated CAD model exists in the Hashtable are added.
      Throws:
      WTException - if any of the invoked methods throws an exception.

    • addReferenceDocPDI

      void addReferenceDocPDI(RevisionControlled part, Map<Object,PartDocInfo> documentInfoMap, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart) throws WTException, ConfigException
      Fetches reference document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      part - Input RevisionControlled object for which to fetch reference document associations.
      documentInfoMap - Input map to add the created PartDocInfo objects to.
      workingIncluded - Determines whether or not working copies are to be included in the output; this is simply passed in to the initialize() API.
      Throws:
      WTException - , ConfigException
      ConfigException

    • addDescribeDocumentPDI

      boolean addDescribeDocumentPDI(RevisionControlled revisionControlled, Map<Object,PartDocInfo> documentInfoMap, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart) throws WTException
      Fetches described by document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      revisionControlled - Input RevisionControlled object for which to fetch described by document associations.
      documentInfoMap - Input map to add the created PartDocInfo objects to.
      workingIncluded - Determines whether or not working copies are to be included in the output; this is simply passed in to the initialize() API.
      Returns:
      A true, if the input object has at least one CAD document associated to it; a false, otherwise.
      Throws:
      WTException

    • addBuildHistoryPDI

      boolean addBuildHistoryPDI(RevisionControlled revisionControlled, Map<Object,PartDocInfo> documentInfoMap, boolean isEnterpriseDataMergeWithPart) throws WTException
      Fetches built by (or BuildHistory) document associations for the input object, creates a PartDocInfo instance for each such association and adds them to the input Hashtable.

      Supported API: true
      Parameters:
      revisionControlled - Input RevisionControlled object for which to fetch BuildHistory document associations.
      documentInfoMap - Input map to add the created PartDocInfo objects to.
      Returns:
      return A true, if the input object has at least one CAD document associated to it, via a BuildHistory association; a false, otherwise.
      Throws:
      WTException

    • addCalculatedDrawings

      void addCalculatedDrawings(RevisionControlled rcObj, Map<Object,PartDocInfo> documentInfoMap, boolean isEnterpriseDataMergeWithPart) throws WTException
      Fetches the calculated drawings for the input RevisionControlled object and adds these to the input Map as appropriate.

      Supported API: true
      Parameters:
      rcObj - RevisionControlled object (such as a WTPart) for which to add calculated drawings.
      documentInfoMap - Input Map to which to add the calculated drawings. See the Javadoc for getCalculatedDrawings() for more information on its contents.
      isEnterpriseDataMergeWithPart - Specifies whether or not to send EnterpriseData and Part information together.
      Throws:
      WTException - if any of the invoked methods throws an exception.

    • addCalculatedDrawings

      void addCalculatedDrawings(Collection<EPMDocument> dwgs, Map<Object,PartDocInfo> documentInfoMap, boolean isEnterpriseDataMergeWithPart) throws WTException
      Adds the drawings in the input collection to the input Map as appropriate.

      Supported API: true
      Parameters:
      dwgs - Input collection of calculated drawings.
      documentInfoMap - Input Map to which to add the drawings. Only those drawings for which an associated CAD model exists in the Map are added.
      isEnterpriseDataMergeWithPart - Specifies whether or not to send EnterpriseData and Part information together.
      Throws:
      WTException - if any of the invoked methods throws an exception.

    • getCADDocumentLinks

      Map<Object,PartDocInfo> getCADDocumentLinks(Set<ObjectReference> enterpriseDatas, WTPart part, boolean isEnterpriseDataMergeWithPart) throws WTException
      Returns Map of CAD Document Links associated with EnterpriseData objects.

      Supported API: true
      Parameters:
      enterpriseDatas - - Set of Enterprise data objects associated with part
      part - - The part with which EnterpriseData objects are associated.
      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:
      - The map of Document Links associated with EnterpriseData objects.
      Throws:
      WTException

    • getDescribeDocumentLinks

      Map<Object,PartDocInfo> getDescribeDocumentLinks(Set<ObjectReference> enterpriseDatas, WTPart part, boolean isEnterpriseDataMergeWithPart) throws WTException
      Returns Map of Describe Document Links associated with EnterpriseData objects.

      Supported API: true
      Parameters:
      enterpriseDatas - - Set of Enterprise data objects associated with part
      part - - The part with which EnterpriseData objects are associated.
      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:
      - Map of Document Links associated with EnterpriseData objects.
      Throws:
      WTException

    • getRefDocumentLinks

      Map<Object,PartDocInfo> getRefDocumentLinks(Set<ObjectReference> enterpriseDatas, WTPart part, boolean isEnterpriseDataMergeWithPart) throws WTException
      Returns Map of Reference Document Links associated with EnterpriseData objects.

      Supported API: true
      Parameters:
      enterpriseDatas - - Set of Enterprise data objects associated with part
      part - - The part with which EnterpriseData objects are associated.
      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:
      - The map of Document Links associated with EnterpriseData objects.
      Throws:
      WTException

    • getTarget

      Collection<ESITarget> getTarget()
      Returns the ESITarget object for the association

      Supported API: true
      Returns:
      ESITarget

    • getPrimaryBusinessObject

      Releasable getPrimaryBusinessObject()
      Gets the value of the attribute primaryBusinessObject. This is the object that was released by the user, or the Change Notice that was automatically associated to the released object when the preference "Automatically Generate Change Notice" has a value "Yes".

      Supported API: true
      Returns:
      A Releasable object that represents the primary business object in the given release.

    • setPrimaryBusinessObject

      void setPrimaryBusinessObject(Releasable obj)
      Sets the attribute primaryBusinessObject to the input object. Supported API: true
      Parameters:
      obj - - Releasable object to set the attribute to.

    • setTarget

      void setTarget(Collection<ESITarget> tgts)
      Sets the ESITarget object for the association Supported API: true
      Parameters:
      Collection - of ESITargets

    • isEnterpriseDataMergeWithPart

      boolean isEnterpriseDataMergeWithPart()
      Lets the caller know if Enterprise Data merge with Part group or not
      Returns 'true' when if Enterprise Data is not merge with part
      Supported API: true
      Returns:
      - Returns 'true' if Enterprise Data is not merge with part *

    • setEnterpriseDataMergeWithPart

      void setEnterpriseDataMergeWithPart(boolean isEnterpriseDataMergeWithPart)
      Sets if enterprise data object is merged with part or rendered separately. Supported API: true
      Parameters:
      isEnterpriseDataMergeWithPart - - 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.