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

Main Class to serve a Ict.Petra.Server.MFinance.GL.WebConnectors.TPeriodMonthEnd request ... More...

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

Public Member Functions

delegate bool StewardshipCalculation (int ALedgerNumber, int APeriodNumber, out List< Int32 >AglBatchNumbers, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase=null)
 
 TMonthEnd (TDataBase ADataBase, TLedgerInfo ALedgerInfo)
 Constructor More...
 
override void SetNextPeriod (TDBTransaction ATransaction)
 Go to next month - unless you're already at the last month! More...
 
bool RunMonthEnd (bool AInfoMode, out List< Int32 >AglBatchNumbers, out Boolean AStewardshipBatch, out TVerificationResultCollection AVRCollection)
 Main Entry point. The parameters are the same as in Ict.Petra.Server.MFinance.GL.WebConnectors.TPeriodMonthEnd 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 StewardshipCalculation StewardshipCalculationDelegate [get, set]
 
static bool WasCancelled [get, set]
 currently not implemented: this can be set to cancel the current operation More...
 

Detailed Description

Main Class to serve a Ict.Petra.Server.MFinance.GL.WebConnectors.TPeriodMonthEnd request ...

Constructor & Destructor Documentation

◆ TMonthEnd()

Ict.Petra.Server.MFinance.GL.TMonthEnd.TMonthEnd ( TDataBase  ADataBase,
TLedgerInfo  ALedgerInfo 
)
inline

Constructor

Parameters
ADataBase
ALedgerInfo

Member Function Documentation

◆ RunMonthEnd()

bool Ict.Petra.Server.MFinance.GL.TMonthEnd.RunMonthEnd ( bool  AInfoMode,
out List< Int32 >  AglBatchNumbers,
out Boolean  AStewardshipBatch,
out TVerificationResultCollection  AVRCollection 
)
inline

Main Entry point. The parameters are the same as in Ict.Petra.Server.MFinance.GL.WebConnectors.TPeriodMonthEnd

Parameters
AInfoMode
AglBatchNumbersThe Client should print the generated Batches
AStewardshipBatchTrue if Stewardship Batch was generated
AVRCollection
Returns
true if it went OK

◆ 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

◆ SetNextPeriod()

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

Go to next month - unless you're already at the last month!

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

◆ StewardshipCalculation()

delegate bool Ict.Petra.Server.MFinance.GL.TMonthEnd.StewardshipCalculation ( int  ALedgerNumber,
int  APeriodNumber,
out List< Int32 >  AglBatchNumbers,
out TVerificationResultCollection  AVerificationResult,
TDataBase  ADataBase = null 
)

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

◆ StewardshipCalculationDelegate

StewardshipCalculation Ict.Petra.Server.MFinance.GL.TMonthEnd.StewardshipCalculationDelegate
staticgetset

◆ 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: