Home > Class Reference > ENSLIB namespace > %iKnow.Filters.ContainsEntityFilter


class %iKnow.Filters.ContainsEntityFilter extends %iKnow.Filters.Filter

%iKnow.Filters.Filter implementation selecting sources based on whether they contain a particular entity or (optionally) any entities similar to the supplied string(s).

Filter parameters:

  1. pDomainId As %Integer
  2. pEntityList As %List - entity values to check for. At least one needs to occur in the source for it to be included in the filter. Values can also be provided as an array, in which case the top node is ignored.
  3. pIncludeSimilar As %Boolean (default 0) - if true, any sources containing an entity "similar" to the supplied ones is also withheld.
  4. pExcludeList As %List - if pIncludeSimilar=1, exclude any entity IDs in this list. Can also be provided as an array, in which case the top node is ignored.
  5. pUseIDs As %Boolean (default 0) - if 1, entity IDs are provided for pEntityList rather than entity values (cannot be combined with pIncludeSimilar=1).

Property Inventory

Method Inventory


property Entities as %List [ MultiDimensional ];
Property methods: EntitiesGet(), EntitiesIsValid(), EntitiesLogicalToOdbc(), EntitiesOdbcToLogical(), EntitiesSet()
property ExcludeList as %List [ MultiDimensional ];
Property methods: ExcludeListGet(), ExcludeListIsValid(), ExcludeListLogicalToOdbc(), ExcludeListOdbcToLogical(), ExcludeListSet()
property IncludeSimilar as %Boolean;
Property methods: IncludeSimilarDisplayToLogical(), IncludeSimilarGet(), IncludeSimilarIsValid(), IncludeSimilarLogicalToDisplay(), IncludeSimilarNormalize(), IncludeSimilarSet()
property UseIDs as %Boolean;
Property methods: UseIDsDisplayToLogical(), UseIDsGet(), UseIDsIsValid(), UseIDsLogicalToDisplay(), UseIDsNormalize(), UseIDsSet()


method ToString() as %String
Inherited description:

Subclasses should implement this method to build a string representation of the filter instance. It should start with the filter class name, followed by a pipe (|) character and then a string representation that can be interpreted by its RestoreFilterFromStringInternal() implementation.

Inherited Members

Inherited Properties

Inherited Methods