Ict.Petra.Server.MFinance.GL.TArchive Class Reference

If the oldest year of data is now beyond the retention period, archive it to file and delete those records. This includes: Gifts, GL Records, Exchange rates (these are multi-ledger, so can only be archived if all ledgers allow it.) More...

Inheritance diagram for Ict.Petra.Server.MFinance.GL.TArchive:

Public Member Functions
	TArchive (TLedgerInfo ALedgerInfo, TDBTransaction ATransaction)
override int	GetJobSize ()
override AbstractPeriodEndOperation	GetActualizedClone ()
override Int32	RunOperation ()

Public Attributes
TPeriodEndOperations	FPeriodEndOperator
	The parent operator (TMonthEnd or TYearEnd) that requests this operation More...

Protected Attributes
TVerificationResultCollection	FverificationResults = null
	This is the standard VerificationResultCollection for the info and the error messages. More...
bool	FInfoMode = true
	See TPeriodEndOperations More...
bool	FHasCriticalErrors = false
	See TPeriodEndOperations More...
int	FCountJobs

Properties
bool	DoExecuteableCode [get]
	!(FHasCriticalErrors | FInfoMode) More...
TVerificationResultCollection	VerificationResultCollection [set]
	Set-Property to set the common value of the VerificationResultCollection (Set by TPeriodEndOperations.RunYearEndSequence) More...
bool	IsInInfoMode [set]
	Property to set the correct info-mode (Set by TPeriodEndOperations.RunYearEndSequence) More...
bool	HasCriticalErrors [get]
	Property to read if the process could be done without critical errors. (Used by TPeriodEndOperations.RunYearEndSequence) More...

Detailed Description

If the oldest year of data is now beyond the retention period, archive it to file and delete those records. This includes: Gifts, GL Records, Exchange rates (these are multi-ledger, so can only be archived if all ledgers allow it.)

NOTE CURRENTLY NOT IMPLEMENTED!

Constructor & Destructor Documentation

TArchive()

Ict.Petra.Server.MFinance.GL.TArchive.TArchive ( TLedgerInfo  ALedgerInfo, TDBTransaction  ATransaction  )

inline

Parameters

ALedgerInfo
ATransaction

Member Function Documentation

GetActualizedClone()

override AbstractPeriodEndOperation Ict.Petra.Server.MFinance.GL.TArchive.GetActualizedClone ( )

inlinevirtual

Implements Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.

GetJobSize()

override int Ict.Petra.Server.MFinance.GL.TArchive.GetJobSize ( )

inlinevirtual

Implements Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.

RunOperation()

override Int32 Ict.Petra.Server.MFinance.GL.TArchive.RunOperation ( )

inlinevirtual

Implements Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.

Member Data Documentation

FCountJobs

int Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.FCountJobs

protectedinherited

FHasCriticalErrors

bool Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.FHasCriticalErrors = false

protectedinherited

See TPeriodEndOperations

FInfoMode

bool Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.FInfoMode = true

protectedinherited

See TPeriodEndOperations

FPeriodEndOperator

TPeriodEndOperations Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.FPeriodEndOperator

inherited

The parent operator (TMonthEnd or TYearEnd) that requests this operation

FverificationResults

TVerificationResultCollection Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.FverificationResults = null

protectedinherited

This is the standard VerificationResultCollection for the info and the error messages.

Property Documentation

DoExecuteableCode

bool Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.DoExecuteableCode

getinherited

!(FHasCriticalErrors | FInfoMode)

HasCriticalErrors

bool Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.HasCriticalErrors

getinherited

Property to read if the process could be done without critical errors. (Used by TPeriodEndOperations.RunYearEndSequence)

IsInInfoMode

bool Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.IsInInfoMode

setinherited

Property to set the correct info-mode (Set by TPeriodEndOperations.RunYearEndSequence)

VerificationResultCollection

TVerificationResultCollection Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.VerificationResultCollection

setinherited

Set-Property to set the common value of the VerificationResultCollection (Set by TPeriodEndOperations.RunYearEndSequence)

---

The documentation for this class was generated from the following file:

• csharp/ICT/Petra/Server/lib/MFinance/GL/GL.PeriodEnd.Year.cs