OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MFinance.GL.TYearEnd Class Reference

Module for the year end calculations ... More...

Inheritance diagram for Ict.Petra.Server.MFinance.GL.TYearEnd:
Ict.Petra.Server.MFinance.Common.TPeriodEndOperations

Public Member Functions

override void SetNextPeriod (TDBTransaction ATransaction)
 Go to period 1 of next year. More...
 
 TYearEnd (TLedgerInfo ALedgerInfo)
 
bool RunYearEnd (bool AInfoMode, out List< Int32 >AglBatchNumbers, out TVerificationResultCollection AVRCollection, TDataBase ADataBase=null)
 Master routine ... More...
 

Protected Member Functions

void RunPeriodEndCheck (AbstractPeriodEndOperation Apeo, TVerificationResultCollection AVerificationResults)
 This is for all info only routines that means JobSize has no definition More...
 
void RunPeriodEndSequence (AbstractPeriodEndOperation AOperation, string AOperationName)
 Standard routine to execute each PeriodEndOperation, and then confirm its success More...
 

Protected Attributes

bool FInfoMode
 If the user invokes a specific year end command, he automatically starts a server request only to make some checks and to gather some specific information. Handling this parameter enables to gather this information in the same routine which is used for the calculations. So both processes are automatically synchronized.
So do not run any excecutive code if the system is in the info mode. More...
 
bool FHasCriticalErrors
 If I run into a critial error, (either in info mode or in executive mode) I can't run any executive code, but it may be useful to gather more information and so the process is not terminated completely. More...
 
TVerificationResultCollection FverificationResults
 This is the standard VerificationResultCollection for the info and the error messages. More...
 

Properties

static bool WasCancelled [get, set]
 currently not implemented: this can be set to cancel the current operation More...
 

Detailed Description

Module for the year end calculations ...

Constructor & Destructor Documentation

◆ TYearEnd()

Ict.Petra.Server.MFinance.GL.TYearEnd.TYearEnd ( TLedgerInfo  ALedgerInfo)
inline

Parameters
ALedgerInfo

Member Function Documentation

◆ RunPeriodEndCheck()

void Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.RunPeriodEndCheck ( AbstractPeriodEndOperation  Apeo,
TVerificationResultCollection  AVerificationResults 
)
inlineprotectedinherited

This is for all info only routines that means JobSize has no definition

◆ RunPeriodEndSequence()

void Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.RunPeriodEndSequence ( AbstractPeriodEndOperation  AOperation,
string  AOperationName 
)
inlineprotectedinherited

Standard routine to execute each PeriodEndOperation, and then confirm its success

Parameters
AOperation
AOperationName

◆ RunYearEnd()

bool Ict.Petra.Server.MFinance.GL.TYearEnd.RunYearEnd ( bool  AInfoMode,
out List< Int32 >  AglBatchNumbers,
out TVerificationResultCollection  AVRCollection,
TDataBase  ADataBase = null 
)
inline

Master routine ...

Parameters
AInfoMode
AglBatchNumbersThe Client should print this list of Batches
AVRCollection
ADataBase
Returns
True if year end succeeded

◆ SetNextPeriod()

override void Ict.Petra.Server.MFinance.GL.TYearEnd.SetNextPeriod ( TDBTransaction  ATransaction)
inlinevirtual

Go to period 1 of next year.

Implements Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.

Member Data Documentation

◆ FHasCriticalErrors

bool Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.FHasCriticalErrors
protectedinherited

If I run into a critial error, (either in info mode or in executive mode) I can't run any executive code, but it may be useful to gather more information and so the process is not terminated completely.

◆ FInfoMode

bool Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.FInfoMode
protectedinherited

If the user invokes a specific year end command, he automatically starts a server request only to make some checks and to gather some specific information. Handling this parameter enables to gather this information in the same routine which is used for the calculations. So both processes are automatically synchronized.
So do not run any excecutive code if the system is in the info mode.

◆ FverificationResults

TVerificationResultCollection Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.FverificationResults
protectedinherited

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

Property Documentation

◆ WasCancelled

bool Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.WasCancelled
staticgetsetinherited

currently not implemented: this can be set to cancel the current operation


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