Package com.ptc.windchill.associativity.accountability

Interface AccountabilityService

All Known Implementing Classes:
AccountabilityServiceImpl
public interface AccountabilityService
The service class for performing different operations on the Accountability Map.

Supported API: true

Extendable: false

  • Method Details

    • populateAccountabilityContent

      AccountabilityReport populateAccountabilityContent(AccountabilityMap accMap, AccountabilityBean accountabilityBean) throws WTException
      This API will consume all information passed in the Accountabilitybean to create a new Accountability map.
      Supported API: true

      Parameters:
      AccountabilityMap - persisted accMap
      AccountabilityBean - - the bean that contains all the selection of roots, NCs and paths required to create Accountability map.
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • generateConfigurationMap

      AccountabilityReport generateConfigurationMap(AccountabilityMap sourceAccMap) throws WTException
      This API will create a new Accountability Map from the source.
      Supported API: true

      Parameters:
      configBean -
      Returns:
      Throws:
      WTException
      WTPropertyVetoException

    • editAccountabilityMap

      AccountabilityReport editAccountabilityMap(AccountabilityMap accMap, AccountabilityBean accBean) throws WTException
      This API will consume all information passed in the Accountabilitybean to edit an existing Accountability map.
      Supported API: true

      Parameters:
      accMap - persisted accMap
      accBean - - the bean that contains all the selection of roots, NCs and paths required to edit Accountability map.
      Returns:
      Throws:
      WTException

    • getAccountabilityMaps

      Set<AccountabilityMap> getAccountabilityMaps(WTPart part) throws WTException
      This API returns all accountability maps that contain the input part(as a value) as well as all accountability maps that have the input part set as root context. All versions of an accountability map found will be returned.
      Supported API: true

      Parameters:
      part -
      Returns:
      Set
      Throws:
      WTException

    • getAccountabilityMapRefs

      Set<ObjectReference> getAccountabilityMapRefs(WTPart part) throws WTException
      This API returns references of all Accountability maps that contain the input part(as a value) as well as references of all accountability maps that have the input part set as root context. All versions of an accountability map found will be returned.
      Supported API: true

      Parameters:
      part -
      Returns:
      Set
      Throws:
      WTException

    • getAccountabilityMaps

      Set<AccountabilityMap> getAccountabilityMaps(Set<WTPart> parts) throws WTException
      This API returns all accountability maps that contain any of the input parts(as a value) as well as all accountability maps that have any of the input parts set as root context. All versions of accountability maps found will be returned.
      Supported API: true

      Parameters:
      part -
      Returns:
      Set
      Throws:
      WTException

    • getAccountabilityMapRefs

      WTSet getAccountabilityMapRefs(WTSet parts) throws WTException
      This API returns references of all Accountability maps that contain any of the input parts(as a value) as well as references of all accountability maps that have any of the input parts set as root context. All versions of accountability maps found will be returned.
      Supported API: true

      Parameters:
      part -
      Returns:
      Set
      Throws:
      WTException

    • getAccountabilityMaps

      Set<ObjectReference> getAccountabilityMaps() throws WTException
      Gets list of accessible Accountability Maps for a user
      Supported API: true

      Returns:
      WTHashSet
      Throws:
      WTException

    • compare

      SmartCollectionComparisonResult compare(CompareSCParams params) throws WTException
      Compares a 'current' revision of a Smart Collection with 'previous' revision.

      Supported API: true

      Parameters:
      params - - CompareSCParams containing current and previous Smart Collection revisions
      Returns:
      SmartCollectionComparisonResult
      Throws:
      WTException

    • getAccountabilityMaps

      Set<ObjectReference> getAccountabilityMaps(boolean isLatestOnly) throws WTException
      Gets list of accessible Accountability Maps for a user If isLatestOnly is set to true, only latest revisions will be returned. *
      Supported API: true

      Parameters:
      isLatestOnly -
      Returns:
      WTHashSet
      Throws:
      WTException