Package com.ptc.windchill.enterprise.data.service

Interface EnterpriseDataDocumentService

@RemoteInterface public interface EnterpriseDataDocumentService
The interface provides services to create and retrieve the EnterpriseData related Describe,Reference and CAD documents.

Supported API: true

Extendable: false

  • Method Details

    • getEnterpriseDataFromWTDocuments

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseData> getEnterpriseDataFromWTDocuments(Set<ObjectReference> wtDocumentReferences) throws WTException
      Returns Multimap of WTDocuments ObjectReference and EnterpriseData

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of WTDocuments
      Returns:
      Map of Documents ObjectReference and EnterpriseData
      Throws:
      WTException

    • getEnterpriseDataFromEPMDocuments

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseData> getEnterpriseDataFromEPMDocuments(Set<ObjectReference> epmDocumentReferences) throws WTException
      Returns Multimap of EPMDocuments ObjectReference and EnterpriseData

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EPMDocuments
      Returns:
      Map of EPMDocuments ObjectReference and EnterpriseData
      Throws:
      WTException

    • getDescribeDocuments

      com.google.common.collect.SetMultimap<ObjectReference,WTDocument> getDescribeDocuments(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and Described Documents

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      Returns:
      Map of EnterpriseData ObjectReference and Described Documents
      Throws:
      WTException

    • getDescribeDocuments

      com.google.common.collect.SetMultimap<ObjectReference,WTDocument> getDescribeDocuments(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and Described Documents filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Map of EnterpriseData ObjectReference and Described Documents
      Throws:
      WTException

    • getReferenceDocuments

      com.google.common.collect.SetMultimap<ObjectReference,WTDocument> getReferenceDocuments(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and Reference Documents

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      Returns:
      Multimap of EnterpriseData ObjectReference and Reference Documents
      Throws:
      WTException

    • getReferenceDocuments

      com.google.common.collect.SetMultimap<ObjectReference,WTDocument> getReferenceDocuments(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and Reference Documents filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and Reference Documents
      Throws:
      WTException

    • getCADDocuments

      com.google.common.collect.SetMultimap<ObjectReference,EPMDocument> getCADDocuments(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and CAD Documents

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      Returns:
      Multimap of EnterpriseData ObjectReference and CAD Documents
      Throws:
      WTException

    • getCADDocuments

      com.google.common.collect.SetMultimap<ObjectReference,EPMDocument> getCADDocuments(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and CAD Documents filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and CAD Documents
      Throws:
      WTException

    • getDescribeDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataDocumentDescribeLink> getDescribeDocumentLinks(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentDescribeLink

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentDescribeLink
      Throws:
      WTException
      See Also:

    • getDescribeDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataDocumentDescribeLink> getDescribeDocumentLinks(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentDescribeLink filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentDescribeLink
      Throws:
      WTException
      See Also:

    • getReferenceDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataDocumentReferenceLink> getReferenceDocumentLinks(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentReferenceLink.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentReferenceLink
      Throws:
      WTException
      See Also:

    • getReferenceDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataDocumentReferenceLink> getReferenceDocumentLinks(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentReferenceLink filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataDocumentReferenceLink
      Throws:
      WTException
      See Also:

    • getCADDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataEPMDocumentDescribeLink> getCADDocumentLinks(Set<ObjectReference> dataReferences)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataEPMDocumentDescribeLink

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - NavigationCriteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataEPMDocumentDescribeLink
      Throws:
      WTException
      See Also:

    • getCADDocumentLinks

      com.google.common.collect.SetMultimap<ObjectReference,EnterpriseDataEPMDocumentDescribeLink> getCADDocumentLinks(Set<ObjectReference> dataReferences, NCServerHolder criteria)
      Returns Multimap of EnterpriseData ObjectReference and EnterpriseDataEPMDocumentDescribeLink filtered by navigation criteria.

      Supported API: true
      Parameters:
      dataReferences - Set of ObjectReferences of EnterpriseData
      criteria - Navigation Criteria Object
      Returns:
      Multimap of EnterpriseData ObjectReference and EnterpriseDataEPMDocumentDescribeLink
      Throws:
      WTException
      See Also:

    • createEnterpriseDataDocDescribeLinks

      Collection createEnterpriseDataDocDescribeLinks(EnterpriseData enterpriseData, Collection<ObjectReference> documents) throws WTException
      Creates EnterpriseDataDocumentDescribeLink between the EnterpriseData and Collection of document ObjectReferences

      Supported API: true
      Parameters:
      enterpriseData - The EnterpriseData object for which describe document links are to be created
      documents - Collection of ObjectReferences of WTDocuments
      Returns:
      Collection of persisted EnterpriseDataDocumentDescribeLink
      Throws:
      WTException
      See Also:

    • createEnterpriseDataDocRefLinks

      Collection createEnterpriseDataDocRefLinks(EnterpriseData enterpriseData, Collection<ObjectReference> documents) throws WTException
      Creates EnterpriseDataDocumentReferenceLink between the EnterpriseData and Collection of WTDocumentMaster object references

      Supported API: true *
      Parameters:
      enterpriseData - The EnterpriseData object for which reference document links are to be created
      documents - Collection of ObjectReferences of WTDocumentMaster
      Returns:
      Collection of persisted EnterpriseDataDocumentReferenceLink
      Throws:
      WTException
      See Also:

    • createEnterpriseDataCADDocLinks

      Collection createEnterpriseDataCADDocLinks(EnterpriseData enterpriseData, Collection<EPMDocument> documents) throws WTException
      Creates EnterpriseDataEPMDocumentDescribeLink between the EnterpriseData and Collection of CAD Document ObjectReferences

      Supported API: true
      Parameters:
      enterpriseData - The EnterpriseData object for which cad document links are to be created
      documents - Collection of ObjectReferences of EPMDocument
      Returns:
      Collection of persisted EnterpriseDataEPMDocumentDescribeLink
      Throws:
      WTException
      See Also: