This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.Filters.SourceIdRangeFilter


Utility filter representing a range of consecutive source IDs.

Filter parameters:

  1. domainId As %Integer
  2. from As %Integer - first Source ID to be included in the range.
  3. to As %Integer - last Source ID to be included in the range.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property From as %Integer;
Property methods: FromDisplayToLogical(), FromGet(), FromIsValid(), FromLogicalToDisplay(), FromNormalize(), FromSet(), FromString()
property To as %Integer;
Property methods: ToArray(), ToBitstring(), ToDisplayToLogical(), ToGet(), ToIsValid(), ToLogicalToDisplay(), ToNormalize(), ToSet(), ToString()

Methods (Including Private)

private method %OnNew(domainId As %Integer, from As %Integer, to As %Integer) 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
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)

FeedbackOpens in a new window