Class Reference
%SYS.Task.PurgeTaskHistory
Server:irisdocs2
Instance:IRISLATEST
User:UnknownUser
 
-
  [%SYS] >  [%SYS] >  [Task] >  [PurgeTaskHistory]
Private  Storage

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

Inventory

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
GetCollectionType GetPropertyName GetSettings GetTaskName
OnSubmit OnTask SetSettings


Parameters

• parameter TaskName = "PurgeTaskHistory";
This defines the user-visible name of this task; This is defined in 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.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.