This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %iKnow.Filters.ContainsRelatedEntitiesFilter extends %iKnow.Filters.Filter

%iKnow.Filters.Filter implementation selecting sources based on whether they contain a particular set of entities in a single context. This means they appear in the same CRC (direct relationship) or path (any relationship) in the sources to be included. Optionally, any entities similar to the supplied ones are also accepted.

Filter parameters:

  1. pDomainId As %Integer
  2. pEntityList As %List - entities to check for, appearing in a relationship with one another.
  3. pDirectRelation As %Boolean (default 0) - if true, the entities in pEntityList should appear in a direct relationship (within the same CRC) with one another. Otherwise, having the entities appear in the same path is enough for a source to be included.
  4. pIncludeSimilar As %Boolean (default 0) - if true, entities similar to the strings in pEntityList are also considered.

Property Inventory (Including Private)

Method Inventory (Including Private)


property DirectRelation as %Boolean;
Property methods: DirectRelationDisplayToLogical(), DirectRelationGet(), DirectRelationIsValid(), DirectRelationLogicalToDisplay(), DirectRelationNormalize(), DirectRelationSet()
property Entities as %List;
Property methods: EntitiesGet(), EntitiesIsValid(), EntitiesLogicalToOdbc(), EntitiesOdbcToLogical(), EntitiesSet()
property IncludeSimilar as %Boolean;
Property methods: IncludeSimilarDisplayToLogical(), IncludeSimilarGet(), IncludeSimilarIsValid(), IncludeSimilarLogicalToDisplay(), IncludeSimilarNormalize(), IncludeSimilarSet()


private method %OnNew(pDomainId As %Integer, pEntityList As %List, pDirectRelation As %Boolean = 0, pIncludeSimilar As %Boolean = 0) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method BuildSourceFilter(maxOffset As %Integer) as %Status
Inherited description:

This is the primary method that needs to be implemented by an actual %iKnow.Filters.Filter subclass to translate the abstract filter criteria the subclass addresses into a bitstring based on Source IDs. The subclass' implementation of this method should use SetSourceBits() for this purpose, setting the requested bitstrings for each offset up to maxOffset.

private classmethod RestoreFilterFromStringInternal(filterParams As %String) as %iKnow.Filters.Filter
Inherited description:

Default implementation, with the filterParams corresponding to all %New() arguments. See also RestoreFilterFromString().

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 (Including Private)

Inherited Methods (Including Private)