Class %SYS.Task.PurgeTaskHistory

class %SYS.Task.PurgeTaskHistory extends %SYS.Task.Definition

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	1	1

Summary

Properties
%RunDate	%RunTime	KeepDays

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
CheckPermission	GetCollectionType	GetPropertyName	GetSettings
GetTaskName	OnSubmit	OnTask	SetSettings

Parameters

• parameter TaskName = "PurgeTaskHistory";

This defines the user-visible name of this task. It is defined in the subclasses.

Properties

• property KeepDays as %Integer(MINVAL=1);

# of Log History Days to keep not including current day, minimum value is 1

Methods

• 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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search