Package com.ptc.windchill.esi.esidoc

Class PartDocInfo

java.lang.Object
com.ptc.windchill.esi.esidoc.PartDocInfo
public class PartDocInfo extends Object
Represents document information identified for export by the retrievePartDocInformation and retrievePartDocDifferences methods of the WTPartService.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static Hashtable<Object,PartDocInfo>
    buildHashtable(RevisionControlled obj)
    Deprecated.
    Use buildMap instead of this API

    Supported API: true
    protected static Hashtable<Object,PartDocInfo>
    buildHashtable(RevisionControlled obj, boolean workingIncluded)
    Deprecated.
    Use buildMap instead of this API.
    protected static Map<Object,PartDocInfo>
    buildMap(RevisionControlled obj, boolean workingIncluded)
    Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller.
    protected static Map<Object,PartDocInfo>
    buildMap(RevisionControlled obj, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart)
    Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller.
    protected static Map<Object,PartDocInfo>
    buildMap(RevisionControlled obj, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart, Releasable pbo, Collection<ESITarget> targets)
    Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller.
    Document
    getDocument()
    Gets the value of the attribute: document; Returns an item that is used to document a part.
    String
    getDocumentType()
    Gets the value of the attribute: documentType; The string representation of the associated document types.
    String
    getDocumentURL()
    Gets the value of the attribute: documentURL; The URL to the details page of the associated document.
    RevisionControlled
    getPart()
    Gets the value of the attribute: part; Returns the part for this PartDocInfo.
    ObjectToObjectLink
    getPartDocLink()
    Gets the value of the attribute: partDocLink; The part to document link that was used to construct this PartUsageInfo.
    protected void
    processForAdd()
    This method is intended to be overriden by a customizer who extends PartDocInfo.
    protected void
    processForDelete()
    This method is intended to be overriden by a customizer who extends PartDocInfo.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getDocument

      public Document getDocument()
      Gets the value of the attribute: document; Returns an item that is used to document a part. The document could be one of the following: an instance of a WTDocument or an instance of a CAD Document. Since both of these objects are persisted in the database, they can be cast to wt.fc.Persistable.

      Supported API: true
      Returns:
      Document

    • getPart

      public RevisionControlled getPart()
      Gets the value of the attribute: part; Returns the part for this PartDocInfo.

      Supported API: true
      Returns:
      RevisionControlled

    • getPartDocLink

      public ObjectToObjectLink getPartDocLink()
      Gets the value of the attribute: partDocLink; The part to document link that was used to construct this PartUsageInfo.

      Supported API: true
      Returns:
      ObjectToObjectLink

    • getDocumentURL

      public String getDocumentURL()
      Gets the value of the attribute: documentURL; The URL to the details page of the associated document.

      Supported API: true
      Returns:
      String

    • getDocumentType

      public String getDocumentType()
      Gets the value of the attribute: documentType; The string representation of the associated document types.

      Supported API: true
      Returns:
      String

    • buildHashtable

      protected static Hashtable<Object,PartDocInfo> buildHashtable(RevisionControlled obj) throws WTException
      Deprecated.
      Use buildMap instead of this API

      Supported API: true
      Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a Hashtable with the fetched information and returns the Hashtable to the caller. The Hashtable is populated with document IDs as keys and PartDocInfo objects holding the fetched document and association information as values. The method attempts to fetch calculated drawings as well, provided there is at least one CAD document associated to the input object. Delegates the actual work to an overloaded API.
      Parameters:
      obj - Input RevisionControlled object for which to populate the output Hashtable.
      Returns:
      Hashtable containing keys and values as described in the method description.
      Throws:
      WTException - , if any of the invoked methods throws this exception.

    • buildHashtable

      protected static Hashtable<Object,PartDocInfo> buildHashtable(RevisionControlled obj, boolean workingIncluded) throws WTException
      Deprecated.
      Use buildMap instead of this API.

      Supported API: true
      Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a Hashtable with the fetched information and returns the Hashtable to the caller. The Hashtable is populated with document IDs as keys and PartDocInfo objects holding the fetched document and association information as values. The method attempts to fetch calculated drawings as well, provided there is at least one CAD document associated to the input object. Delegates the actual work to an overloaded API.
      Parameters:
      obj - Input RevisionControlled object for which to populate the output Hashtable.
      Returns:
      Hashtable containing keys and values as described in the method description.
      Throws:
      WTException - , if any of the invoked methods throws this exception.

    • buildMap

      protected static Map<Object,PartDocInfo> buildMap(RevisionControlled obj, boolean workingIncluded) throws WTException
      Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller. The map is populated with document IDs as keys and PartDocInfo objects holding the fetched document and association information as values. The method attempts to fetch calculated drawings as well, provided there is at least one CAD document associated to the input object. Also, either working or original copies of the associated documents are returned according as a true or a false was passed in for the boolean argument respectively.

      Supported API: true
      Parameters:
      obj - Input RevisionControlled object for which to populate the output Hashtable.
      workingIncluded - A true or a false, according as working or original copies of the associated documents are to be included in the output respectively.
      Returns:
      - The map containing keys and values as described in the method description.
      Throws:
      WTException - , if any of the invoked methods throws this exception.

    • buildMap

      protected static Map<Object,PartDocInfo> buildMap(RevisionControlled obj, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart) throws WTException
      Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller. The map is populated with document IDs as keys and PartDocInfo objects holding the fetched document and association information as values. The method attempts to fetch calculated drawings as well, provided there is at least one CAD document associated to the input object. Also, either working or original copies of the associated documents are returned according as a true or a false was passed in for the boolean argument respectively.

      Supported API: true
      Parameters:
      obj - Input RevisionControlled object for which to populate the output Hashtable.
      workingIncluded - A true or a false, according as working or original copies of the associated documents are to be included in the output respectively.
      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 containing keys and values as described in the method description.
      Throws:
      WTException - , if any of the invoked methods throws this exception.

    • buildMap

      protected static Map<Object,PartDocInfo> buildMap(RevisionControlled obj, boolean workingIncluded, boolean isEnterpriseDataMergeWithPart, Releasable pbo, Collection<ESITarget> targets) throws WTException
      Fetches the documents associated to the input object (including those associated to the relevant ERPMaterial object if the input object happens to be a WTPart), populates a map with the fetched information and returns the map to the caller. The map is populated with document IDs as keys and PartDocInfo objects holding the fetched document and association information as values. The method attempts to fetch calculated drawings as well, provided there is at least one CAD document associated to the input object. Also, either working or original copies of the associated documents are returned according as a true or a false was passed in for the boolean argument respectively.

      Supported API: true
      Parameters:
      obj - Input RevisionControlled object for which to populate the output Map.
      workingIncluded - A true or a false, according as working or original copies of the associated documents are to be included in the output respectively.
      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.
      pbo - Primary business object
      targets - Collection of ESI Targets
      Returns:
      - The map containing keys and values as described in the method description.
      Throws:
      WTException - , if any of the invoked methods throws this exception.

    • processForAdd

      protected void processForAdd()
      This method is intended to be overriden by a customizer who extends PartDocInfo. The method is available should the information stored in this object need to be processed in the event that documents have been added to the part. The customizer must invoke this method for the superclass as its first statement.

      Supported API: true

    • processForDelete

      protected void processForDelete()
      This method is intended to be overriden by a customizer who extends PartDocInfo. The method is available should the information stored in this object need to be processed in the event that the a document has been removed from a part. The customizer must invoke this method for the superclass as its first statement.

      Supported API: true