Skip to main content

HS.Registry.Document.Archive.Task

class HS.Registry.Document.Archive.Task extends %SYS.Task.Definition

This is the task definition that can be used to build a list of documents to be archived.
This task should be called once a year or so (ideally based on the minimum value of PurgeDefaultDays so that new documents don't need to be added to the list until the next run), and whenever the Rules are changed for a given Facility/SourceId

Property Inventory

Method Inventory

Properties

property CurrentRepository as %String [ InitialExpression = ##class(HS.Data.OIDMap).GetOIDForCode("HSREPOSITORY") ];
OID code for current repository
Property methods: CurrentRepositoryDisplayToLogical(), CurrentRepositoryGet(), CurrentRepositoryIsValid(), CurrentRepositoryLogicalToDisplay(), CurrentRepositoryLogicalToOdbc(), CurrentRepositoryNormalize(), CurrentRepositorySet()
property DefaultPurgeDays as %Integer [ InitialExpression = 365.25*3\1 ];
Property methods: DefaultPurgeDaysDisplayToLogical(), DefaultPurgeDaysGet(), DefaultPurgeDaysIsValid(), DefaultPurgeDaysLogicalToDisplay(), DefaultPurgeDaysNormalize(), DefaultPurgeDaysSet()
property RefreshList as %Boolean [ InitialExpression = 0 ];
if RefreshList is true then the purge date will be recomputed for existing records
Property methods: RefreshListDisplayToLogical(), RefreshListGet(), RefreshListIsValid(), RefreshListLogicalToDisplay(), RefreshListNormalize(), RefreshListSet()
property SourceIDS as list of %String;
Property methods: SourceIDSBuildValueArray(), SourceIDSCollectionToDisplay(), SourceIDSCollectionToOdbc(), SourceIDSDisplayToCollection(), SourceIDSDisplayToLogical(), SourceIDSGet(), SourceIDSGetObject(), SourceIDSGetObjectId(), SourceIDSGetSwizzled(), SourceIDSIsValid(), SourceIDSLogicalToDisplay(), SourceIDSLogicalToOdbc(), SourceIDSNormalize(), SourceIDSOdbcToCollection(), SourceIDSSet(), SourceIDSSetObject(), SourceIDSSetObjectId()
property UseCreationTimeInternal as %Boolean [ InitialExpression = 0 ];
use CreationTimeInternal (effective registration time) instead of CreationTime
(time provided in registration message)
Property methods: UseCreationTimeInternalDisplayToLogical(), UseCreationTimeInternalGet(), UseCreationTimeInternalIsValid(), UseCreationTimeInternalLogicalToDisplay(), UseCreationTimeInternalNormalize(), UseCreationTimeInternalSet()

Methods

method BuildList() as %Status
method CheckValue(pRef, pProperty, pValue) as %Boolean
method DeterminePurgeDate(pID, Output pSC) as %Date
method GetRules(pSourceID, pSC) as %ListOfObjects
method HasReferenceValue(pRef, pNextName, pValue) as %Boolean
ex tObject.Property[].Code tObject.Property[] value=@Code="foo"@CodingScheme="bar"
method OnTask() as %Status
Inherited description: 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.
method OneRow(pLastLogical, pRS) as %Status
method RecalculateAfterRuleChange() as %Status
method UpdatePurgeDate(pLogicalIID, pSourceID, pVersion, pDate) as %Status

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab