Interface ContentControlService

All Known Implementing Classes:
StandardContentControlService

@RemoteInterface public interface ContentControlService
Remotely Invokable Service Interface specification for the Content Control UI to manipulate the Collection Graph of ContentControlLinks. Allows the UI to traverse to the leaf nodes which will be shown on the UI and trigger the actions (viz, exclude,include).

Supported API: true

Extendable: false
  • Method Details

    • getIncludedContentFiles

      WTKeyedMap getIncludedContentFiles(AbstractWorkPackage c) throws WTException
      Returns a Map with Context Object as key and set of included content file names as value. - If there are no context objects with included content items, returns empty map. - If parameter is null, throws WTException.

      Supported API: true

      Extendable: false
      Parameters:
      wp -
      Returns:
      WTKeyedMap keys - Persistable values - Set of excluded content file names
      Throws:
      WTException
    • getExcludedContentFiles

      WTKeyedMap getExcludedContentFiles(AbstractWorkPackage wp) throws WTException
      Returns a Map with Context Object as key and set of excluded content file names as value. - If there are no context objects with excluded content items, returns empty map. - If parameter is null, throws WTException.

      Supported API: true

      Extendable: false
      Parameters:
      wp -
      Returns:
      WTKeyedMap keys - Persistable values - Set of included content file names
      Throws:
      WTException
    • getNonExcludableContentLinks

      WTArrayList getNonExcludableContentLinks(AbstractWorkPackage workPackage) throws WTException
      This method will return all non-excludable content control content links.

      Supported API: true

      Extendable: false
      Parameters:
      workPackage - - AbstractWorkPackage
      Throws:
      WTException