Package com.ptc.arbortext.windchill.publisher.payload

Interface ElementFilter

public interface ElementFilter
An interface that is used to filter information element based on customized criteria. Only one instance is used for the whole payload publish.

Supported API: true
Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    filter(PayloadContext context, Persistable curElement, WTList associated)
     

  • Method Details

    • filter

      boolean filter(PayloadContext context, Persistable curElement, WTList associated) throws WTException
      Parameters:
      context -
      curElement - it could be WTPart, PartList
      associated - a list of Persistable objects. If the current element points to a structured document, such as dynamic document, only its root dynamic is included. Depending business logic, users may need to check its children.
      Returns:
      true means we don't include the Element. Otherwise, including the element in the payload. If the element is not included and the publish shall stop, exception is expected in this case.
      Throws:
      WTException -

      Supported API: true