OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation Class Referenceabstract

The period end classes inherit and complete this abstract class. The constructor of the inheriting class handles all parameters which are necessary for the RunEndOfPeriodOperation and RunEndOfPeriodOperation handles the database operations. More...

Inheritance diagram for Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation:
Ict.Petra.Server.MFinance.GL.RunMonthEndChecks Ict.Petra.Server.MFinance.GL.RunMonthlyAdminFees Ict.Petra.Server.MFinance.GL.TAccountPeriodToNewYear Ict.Petra.Server.MFinance.GL.TArchive Ict.Petra.Server.MFinance.GL.TGlmNewYearInit Ict.Petra.Server.MFinance.GL.TReallocation Ict.Petra.Server.MFinance.GL.TResetForwardPeriodBatches Ict.Petra.Server.MFinance.GL.TResetForwardPeriodICH Ict.Testing.Petra.Server.MFinance.GL.TestOperation

Public Member Functions

abstract int GetJobSize ()
 GetJobSize returns the number of database records which are affected in this operation. Be sure not only to find the databases which are to be changed but also not to find the records which are already changed. Or: Be sure that JobSize is zero after RunEndOfPeriodOperation has been done sucessfully. More...
 
abstract Int32 RunOperation ()
 The specific operation is done. Be sure to handle blnIsInInfoMode and blnCriticalErrors correctly More...
 
abstract AbstractPeriodEndOperation GetActualizedClone ()
 Method to create a duplicate based on the actualized database value(s) More...
 

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

The period end classes inherit and complete this abstract class. The constructor of the inheriting class handles all parameters which are necessary for the RunEndOfPeriodOperation and RunEndOfPeriodOperation handles the database operations.

Member Function Documentation

◆ GetActualizedClone()

◆ GetJobSize()

abstract int Ict.Petra.Server.MFinance.Common.AbstractPeriodEndOperation.GetJobSize ( )
pure virtual

GetJobSize returns the number of database records which are affected in this operation. Be sure not only to find the databases which are to be changed but also not to find the records which are already changed. Or: Be sure that JobSize is zero after RunEndOfPeriodOperation has been done sucessfully.

Implemented in Ict.Petra.Server.MFinance.GL.RunMonthEndChecks, Ict.Petra.Server.MFinance.GL.RunMonthlyAdminFees, Ict.Petra.Server.MFinance.GL.TArchive, Ict.Petra.Server.MFinance.GL.TReallocation, Ict.Petra.Server.MFinance.GL.TAccountPeriodToNewYear, Ict.Petra.Server.MFinance.GL.TGlmNewYearInit, Ict.Petra.Server.MFinance.GL.TResetForwardPeriodBatches, Ict.Petra.Server.MFinance.GL.TResetForwardPeriodICH, and Ict.Testing.Petra.Server.MFinance.GL.TestOperation.

◆ RunOperation()

Member Data Documentation

◆ FCountJobs

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

◆ FHasCriticalErrors

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

◆ FInfoMode

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

◆ FPeriodEndOperator

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

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

◆ FverificationResults

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

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

Property Documentation

◆ DoExecuteableCode

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

!(FHasCriticalErrors | FInfoMode)

◆ HasCriticalErrors

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

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
set

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

◆ VerificationResultCollection

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

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: