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 > %SYS.Task.ShadowPurge

%SYS.Task.ShadowPurge

class %SYS.Task.ShadowPurge extends %SYS.Task.Definition

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter TaskName = ShadowPurge;
Inherited description: This defines the user-visible name of this task; This is defined in subclasses.

Properties (Including Private)

property ShadowID as %String;
Property methods: ShadowIDDisplayToLogical(), ShadowIDGet(), ShadowIDIsValid(), ShadowIDLogicalToDisplay(), ShadowIDLogicalToOdbc(), ShadowIDNormalize(), ShadowIDSet()

Methods (Including Private)

method OnTask() as %Status
This method is responsible for executing the task.
At the scheduled time, the Task Manager creates an instance of this object, sets any property values using the stored "settings" for the task, and then invokes this method to execute the task.
In order to execute a real task, override this method in a subclass.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)