Package com.ptc.windchill.enterprise.workSet.util

Class WorkSetManagementHelper

java.lang.Object
com.ptc.windchill.enterprise.workSet.util.WorkSetManagementHelper
All Implemented Interfaces:
Serializable, RemoteAccess
public class WorkSetManagementHelper extends Object implements RemoteAccess, Serializable
Class for helper methods related to Work Sets

Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields inherited from interface wt.method.RemoteAccess

    versionID

  • Method Summary

    Modifier and Type
    Method
    Description
    RelatedObjectsBean
    addReferenceDocuments(NmCommandBean clientData)
    Given a WTWorkSet object and a collection of object, create the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.
    RelatedObjectsBean
    addReferenceDocuments(NmCommandBean clientData, WTCollection referenceDocs)
    Given a WTWorkSet object and a collection of object, create the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.
    static String
    getValidReferenceDocumentList(NmCommandBean clientData)
    Returns the comma delimited String of the external form of the type names for each in the List of valid Workset reference document.
    WTWorkSet
    getWorkingCopy(WTWorkSet workset)
    Given a WTWorkSet object, return its working copy if it is checked out by the the current user Otherwise, check it out if the user has the permission and return its working copy.
    WTWorkSet
    getWorkSet(NmCommandBean clientData)
    Get the WorkSet from the NmCommandBean using by using the PrimaryOid

    Supported API: true
    RelatedObjectsBean
    removeReferenceDocuments(NmCommandBean clientData)
    Given a WTWorkSet object and a collection of object, remove the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.
    RelatedObjectsBean
    updateComponentLinks(WTCollection components, WTWorkSet workset, String action)
    Given a WTWorkSet object and a collection of object, create/remove the WTWorkSetComponentLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.
    RelatedObjectsBean
    updateComponents(NmCommandBean clientData, String action)
    Given a WTWorkSet object and a collection of object, create/remove the WTWorkSetComponentLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • updateComponents

      public RelatedObjectsBean updateComponents(NmCommandBean clientData, String action) throws WTException
      Given a WTWorkSet object and a collection of object, create/remove the WTWorkSetComponentLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

      Supported API: true
      Parameters:
      clientData - - The NmCommandBean containing the WTWorkSet object as the primary object and the collection of component objects as selected objects
      action -
      Returns:
      - A bean of the working copy of the WTWorkSet object and a list of the component objects whose links are not processed successfully.
      Throws:
      WTException

    • getWorkSet

      public WTWorkSet getWorkSet(NmCommandBean clientData) throws WTException
      Get the WorkSet from the NmCommandBean using by using the PrimaryOid

      Supported API: true
      Parameters:
      clientData -
      Returns:
      WTWorkSet
      Throws:
      WTException

    • updateComponentLinks

      public RelatedObjectsBean updateComponentLinks(WTCollection components, WTWorkSet workset, String action) throws WTException
      Given a WTWorkSet object and a collection of object, create/remove the WTWorkSetComponentLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

      Supported API: true
      Parameters:
      components - - A collection of component objects
      workset - - A WTWorkSet object
      action -
      Returns:
      - A bean of the working copy of the WTWorkSet object and a list of the component objects whose links are not processed successfully.
      Throws:
      WTException

    • getWorkingCopy

      public WTWorkSet getWorkingCopy(WTWorkSet workset) throws WTException
      Given a WTWorkSet object, return its working copy if it is checked out by the the current user Otherwise, check it out if the user has the permission and return its working copy. Null is returned if neither above is applicable.

      Supported API: true
      Parameters:
      workset - WTWorkset object
      Returns:
      the working copy of the WTWorkSet object
      Throws:
      WTException

    • addReferenceDocuments

      public RelatedObjectsBean addReferenceDocuments(NmCommandBean clientData) throws WTException
      Given a WTWorkSet object and a collection of object, create the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

      Supported API: true
      Parameters:
      clientData -
      Returns:
      - A bean of the working copy of the WTWorkSet object and a list of objects not processed.
      Throws:
      WTException

    • addReferenceDocuments

      public RelatedObjectsBean addReferenceDocuments(NmCommandBean clientData, WTCollection referenceDocs) throws WTException
      Given a WTWorkSet object and a collection of object, create the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

      Supported API: true
      Parameters:
      clientData -
      referenceDocs -
      Returns:
      - A bean of the working copy of the WTWorkSet object and a list of objects not processed.
      Throws:
      WTException

    • removeReferenceDocuments

      public RelatedObjectsBean removeReferenceDocuments(NmCommandBean clientData) throws WTException
      Given a WTWorkSet object and a collection of object, remove the WTWorkSetReferenceLinks between the working copy of the WTWorkSet object and each of the object in the collection The WTWorkSet object will be checked out if it is not a working copy.

      Supported API: true
      Parameters:
      clientData -
      Returns:
      - A bean of the working copy of the WTWorkSet object and a list of objects not processed.
      Throws:
      WTException

    • getValidReferenceDocumentList

      public static String getValidReferenceDocumentList(NmCommandBean clientData) throws WTException
      Returns the comma delimited String of the external form of the type names for each in the List of valid Workset reference document.

      Supported API: true
      Parameters:
      clientData -
      Returns:
      A comma delimited String of the type names of Work Set reference document types.
      Throws:
      WTException