Ens.Util.Tasks.PurgeActivityData
class Ens.Util.Tasks.PurgeActivityData extends %SYS.Task.Definition
Property Inventory
Method Inventory
Parameters
parameter RESOURCE = %Ens_PurgeSchedule:USE;
Inherited description: This specifies a security resource and optional permission. Access to the resource
will be required to create, modify or run a task of this type.
The format is ":". If is ommited, "USE" is implied.
Note that this parameter cannot be overridden using the COSEXPRESSION parameter type.
Properties
property LengthOfPeriodToKeep as %Integer (MINVAL = 0) [ InitialExpression = 1 ];
Amount of period to purge
Property methods: LengthOfPeriodToKeepDisplayToLogical(), LengthOfPeriodToKeepGet(), LengthOfPeriodToKeepIsValid(), LengthOfPeriodToKeepLogicalToDisplay(), LengthOfPeriodToKeepNormalize(), LengthOfPeriodToKeepSet()
property PeriodToKeep as %String (DISPLAYLIST = ",Seconds,Minutes,Hours,Days,Weeks,Month,Year", VALUELIST = ",s,mi,hh,d,wk,mm,yy") [ InitialExpression = "d" ];
Unit of period to purge
Property methods: PeriodToKeepDisplayToLogical(), PeriodToKeepGet(), PeriodToKeepIsValid(), PeriodToKeepLogicalToDisplay(), PeriodToKeepLogicalToOdbc(), PeriodToKeepNormalize(), PeriodToKeepSet()
property TableToPurge as %String (DISPLAYLIST = ",Seconds Table,Hourly Table, Daily Table", VALUELIST = ",s,hh,d") [ InitialExpression = "s" ];
Activity Table to purge
Property methods: TableToPurgeDisplayToLogical(), TableToPurgeGet(), TableToPurgeIsValid(), TableToPurgeLogicalToDisplay(), TableToPurgeLogicalToOdbc(), TableToPurgeNormalize(), TableToPurgeSet()
property WriteCountInEventLog as %Boolean;
Property methods: WriteCountInEventLogDisplayToLogical(), WriteCountInEventLogGet(), WriteCountInEventLogIsValid(), WriteCountInEventLogLogicalToDisplay(), WriteCountInEventLogNormalize(), WriteCountInEventLogSet()
Methods
method OnTask() as %Status
The OnTask() method is called to execute the task
Inherited Members
Inherited Properties
Inherited 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()
- SetSettings()