Package wt.epm.workspaces

Interface EPMWorkspaceManager

All Known Implementing Classes:
EPMStandardWorkspaceManager
@RemoteInterface public interface EPMWorkspaceManager


Supported API: true

Extendable: false

  • Field Details

    • POPULATE_WS_FLAG_PART_CENTRIC

      static final int POPULATE_WS_FLAG_PART_CENTRIC


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_DOC_CENTRIC

      static final int POPULATE_WS_FLAG_DOC_CENTRIC


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_DEPENDENCIES_NONE

      static final int POPULATE_WS_FLAG_DEPENDENCIES_NONE


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_DEPENDENCIES_ALL

      static final int POPULATE_WS_FLAG_DEPENDENCIES_ALL


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_DEPENDENCIES_REQUIRED

      static final int POPULATE_WS_FLAG_DEPENDENCIES_REQUIRED


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_FT_INCLUDE_GENERIC

      static final int POPULATE_WS_FLAG_FT_INCLUDE_GENERIC


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_FT_INCLUDE_INSTANCES

      static final int POPULATE_WS_FLAG_FT_INCLUDE_INSTANCES


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_FT_INCLUDE_ALL

      static final int POPULATE_WS_FLAG_FT_INCLUDE_ALL


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_FT_CHECK_COMPATIBILITY

      static final int POPULATE_WS_FLAG_FT_CHECK_COMPATIBILITY


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_INCLUDE_DRAWINGS

      static final int POPULATE_WS_FLAG_INCLUDE_DRAWINGS


      Supported API: true
      See Also:

    • POPULATE_WS_FLAG_FT_INCLUDE_IN_WS_ONLY

      static final int POPULATE_WS_FLAG_FT_INCLUDE_IN_WS_ONLY


      Supported API: true
      See Also:

    • NO_WORKSPACE_SIZE_LIMIT

      static final int NO_WORKSPACE_SIZE_LIMIT


      Supported API: true
      See Also:

  • Method Details

    • checkout

      WTValuedMap checkout(EPMWorkspace workspace, WTCollection objects) throws WTException
      Checks out the given list of objects to the given workspace folder. Returns a map whose keys are the given list of object and whose values are the working copies.

      Supported API: true
      Parameters:
      workspace -
      objects - A collection of objects to be checked out.
      Returns:
      WTValuedMap
      Throws:
      WTException

    • convertCheckout

      WTValuedMap convertCheckout(EPMWorkspace workspace, WTCollection privatelyCheckedOutDocs, WorkInProgressState wipstate) throws WTException
      Converts the given list of privately checked out objects to reserved checked out. Returns a map whose keys are the given list of object and whose values are the working copies.

      Supported API: true
      Parameters:
      workspace -
      objects - A collection of privately checked out objects to be reserved checked out.
      Returns:
      WTValuedMap
      Throws:
      WTException

    • undoCheckout

      WTSet undoCheckout(EPMWorkspace workspace, WTCollection workingCopies) throws WTException
      Undoes check out the given list of working copies from the given workspace folder. Returns a WTSet of originals. Please note that the object is removed from the workspace. If the desired behavior is to restore the original to the workspace, use undoCheckoutAndRestoreInWorkspace.

      Supported API: true
      Parameters:
      workspace -
      workingCopies - A collection of working copies objects in the workspace to be undo checked out
      Returns:
      WTSet
      Throws:
      WTException

    • checkin

      WTSet checkin(EPMWorkspace workspace, WTKeyedMap toCheckin) throws WTException
      Deprecated.
      Checks in the given list of working copies or new objects.

      Supported API: true
      Parameters:
      workspace -
      toCheckin - The keys are the working copies to be checked in and the values are CheckinOption objects. If the CheckinOption is null, the checkin comment is set to an empty string and the object is moved to the target folder.
      Returns:
      WTSet
      Throws:
      WTException

    • checkin

      WTSet checkin(EPMWorkspace workspace, WTKeyedMap toCheckin, wt.epm.EPMGhostResolverBase.EPMGhostResolverDelegate ghostResolutionDelegate) throws WTException
      Deprecated.
      Checks in the given list of working copies or new objects.

      Supported API: true
      Parameters:
      workspace -
      toCheckin - The keys are the working copies to be checked in and the values are CheckinOption objects. If the CheckinOption is null, the checkin comment is set to an empty string and the object is moved to the target folder.
      ghostResolutionDelegate -
      Returns:
      WTSet
      Throws:
      WTException

    • addToWorkspace

      EPMWorkspace addToWorkspace(EPMWorkspace workspace, WTCollection baselineables) throws WTException
      Add the specified baselineable objects and family table objectsto the Workspace. If another item in theWorkspace has the same Master as the Baselineable, then the current item in the Workspace is replaced with this Baselineable. If the iteration is currently part of theWorkspace, then nothing occurs and no exception is thrown

      Supported API: true
      Parameters:
      workspace - The workspace to be affected by the call.
      baselineables -
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • removeFromWorkspace

      EPMWorkspace removeFromWorkspace(EPMWorkspace workspace, WTCollection baselinables) throws WTException
      Remove the specified objects from the Workspace.

      Supported API: true
      Parameters:
      workspace - The workspace to be affected by the call.
      baselinables -
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • populateWorkspace

      EPMWorkspace populateWorkspace(EPMWorkspace workspace, WTCollection baselineables) throws WTException
      Adds the Baselineable item iterations to the Workspace.

      Supported API: true
      Parameters:
      workspace - The workspace to be affected by the call.
      baselineables - A collection of objects to be added (together with the related items determined by the populareRule) to the workspace.
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • populateWorkspace

      EPMWorkspace populateWorkspace(EPMWorkspace workspace, WTCollection baselineables, int flags) throws WTException
      Adds the Baselineable item iterations to the Workspace.

      Supported API: true
      Parameters:
      workspace - The workspace to be affected by the call.
      baselineables - A collection of objects to be added (together with the related items determined by the populareRule) to the workspace.
      flags - Population flags
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • getObjectsInWorkspace

      WTSet getObjectsInWorkspace(EPMWorkspace workspace, Class classObject) throws WTException
      Get the set of objects included in the Checkpoint associated with the workspace. Returns the set of objects of specified class which are present in the given workspace. If the workspace does not contain any object of the Class provided, then an empty set of size 0 will be returned.

      Supported API: true
      Parameters:
      workspace - The workspace to be affected by the call.
      classObject -
      Returns:
      WTSet Returns the set of objects present in the given workspace.
      Throws:
      WTException

    • getWorkspaces

      WTSet getWorkspaces(WTPrincipal user, WTContainerRef solution) throws WTException
      Returns all of the workspaces associated with a given user and container. If user is not specified, current principal is used. If container is not specified, all the workspaces of the user are returned. If the container is a reference to a PDMLink container, returns all the workspaces of that solution and not that specific PDMLink container. In order to get the workspaces associated with that specific PDMLink container, filter the returns set accordingly. If there are no workspaces associated with a given user and the specified container, then an empty set of size 0 is returned.

      Supported API: true
      Parameters:
      user -
      solution -
      Returns:
      WTSet Returns the set of workspaces that are associated with a given user and the specified container
      Throws:
      WTException

    • getNewObjects

      WTSet getNewObjects(WTCollection objects) throws WTException
      Given a list of objects, returns a set of new objects. An object is new if it is an EPMDocument or a WTPart that has never been checked in, thus, there is no iteration in any other folders except the workspace folder.

      Supported API: true
      Parameters:
      objects - A collection of EPMDocument or WTPart
      Returns:
      WTSet
      Throws:
      WTException

    • undoCheckoutAndRestoreInWorkspace

      WTSet undoCheckoutAndRestoreInWorkspace(EPMWorkspace workspace, WTCollection workingCopies) throws WTException
      Undoes check out the given list of working copies from the given workspace folder and restores originals in Workspace baseline. Returns a WTSet of originals.

      Supported API: true
      Parameters:
      workspace -
      workingCopies - A collection of working copies in the workspace to be undo checked out.
      Returns:
      WTSet
      Throws:
      WTException

    • setAttributes

      void setAttributes(EPMWorkspace workspace, WTKeyedMap attrValues) throws WTException
      Set the attribute values (IBA) passed for each of the EPMDocument passed in attrValues. It handles propogation of IBA values to Family table instances that inherit the values from generics. The API can also be used to set IBA values on instances where the attribute is part of Family Table.

      Supported API: true
      Parameters:
      workspace - EPMWorkspace to which the passed EPMDocuments are checked-out.
      attrValues - WTKeyedMap where key is EPMDocument and the value is a Map of IBA name and IBA value. The IBA value can be NULL.
      Throws:
      WTException

    • undoCheckout

      WTSet undoCheckout(WTCollection workingCopies) throws WTException
      Undoes check out the given list of working copies from the given workspace folder. Returns a WTSet of originals. Please note that the object is removed from the workspace. If the desired behavior is to restore the original to the workspace, use undoCheckoutAndRestoreInWorkspace.

      Supported API: true
      Parameters:
      workingCopies - A collection of objects to be undo checked out.
      Returns:
      WTSet
      Throws:
      WTException

    • createTransparentWorkspace

      EPMWorkspace createTransparentWorkspace(NavigationCriteria partNavigationCriteria, NavigationCriteria docNavigationCriteria, WTContainer container) throws WTException
      Creates a new transparent workspace for the given container.

      Supported API: true
      Parameters:
      partNavigationCriteria - Part navigation criteria for the workspace, If null, then navigation criteria constructed from the latest WTPartConfigSpec will be assigned to the part navigation criteria.
      docNavigationCriteria - Document navigation criteria for the workspace, If null, then navigation criteria constructed from the latest EPMDocConfigSpec will be assigned to the document navigation criteria.
      container - Workspace context
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • createTransparentWorkspace

      EPMWorkspace createTransparentWorkspace(NavigationCriteria partNavigationCriteria, NavigationCriteria docNavigationCriteria, WTContainer container, boolean disableCSTracking) throws WTException
      Creates a new transparent workspace for the given container

      Supported API: true
      Parameters:
      partNavigationCriteria - Part navigation criteria for the workspace, If null, then navigation criteria constructed from the latest WTPartConfigSpec will be assigned to the part navigation criteria.
      docNavigationCriteria - Document navigation criteria for the workspace, If null, then navigation criteria constructed from the latest EPMDocConfigSpec will be assigned to the document navigation criteria.
      container - Workspace context
      disableCSChangeTracking - Set to true if the common space change tracking is to be disabled for the workspace.
      Returns:
      EPMWorkspace
      Throws:
      WTException

    • checkin

      WTSet checkin(EPMWorkspace workspace, WTKeyedMap toCheckin, WTCollection alwaysBuild, WTCollection buildIfNotAlreadyBuilt) throws WTException
      Checks in the given list of working copies or new objects.

      Supported API: true
      Parameters:
      workspace -
      toCheckin - The keys are the working copies to be checked in and the values are CheckinOption objects. If the CheckinOption is null, the checkin comment is set to an empty string and the object is moved to the target folder.
      alwaysBuild - The collection of objects to build irrespective of whether already built or not.
      buildIfNotAlreadyBuilt - The collection of objects to build if objects are not already built.
      Returns:
      WTSet
      Throws:
      WTException

    • checkin

      WTSet checkin(EPMWorkspace workspace, WTKeyedMap toCheckin, wt.epm.EPMGhostResolverBase.EPMGhostResolverDelegate ghostResolutionDelegate, WTCollection alwaysBuild, WTCollection buildIfNotAlreadyBuilt) throws WTException
      Checks in the given list of working copies or new objects.

      Supported API: true
      Parameters:
      workspace -
      toCheckin - The keys are the working copies to be checked in and the values are CheckinOption objects. If the CheckinOption is null, the checkin comment is set to an empty string and the object is moved to the target folder.
      ghostResolutionDelegate -
      alwaysBuild - The collection of objects to build irrespective of whether already built or not.
      buildIfNotAlreadyBuilt - The collection of objects to build if objects are not already built.
      Returns:
      WTSet
      Throws:
      WTException

    • checkin

      WTSet checkin(EPMWorkspace workspace, WTKeyedMap toCheckin, wt.epm.EPMGhostResolverBase.EPMGhostResolverDelegate ghostResolutionDelegate, WTCollection alwaysBuild, WTCollection buildIfNotAlreadyBuilt, BuildResolverDelegate[] buildResolverDelegate) throws WTException
      Checks in the given list of working copies or new objects.

      Supported API: true
      Parameters:
      workspace -
      toCheckin - The keys are the working copies to be checked in and the values are CheckinOption objects. If the CheckinOption is null, the checkin comment is set to an empty string and the object is moved to the target folder.
      ghostResolutionDelegate -
      alwaysBuild - The collection of objects to build irrespective of whether already built or not.
      buildIfNotAlreadyBuilt - The collection of objects to build if objects are not already built.
      buildResolverDelegate - array of BuildResolverDelegates
      Returns:
      WTSet
      Throws:
      WTException