Ict.Petra.Server.MFinance.Common.TPeriodEndOperations Class Reference

If a procedure is defined which shall be assigned inside a specific perodic process you have to use this class the handle the operation itself and the AbstractPeriodEndOperation class to handle the internal parts of the operation.
For example the class TMonthEnd and TYearEnd inherits TPeriodEndOperations.
More...

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

Public Member Functions
abstract void	SetNextPeriod (TDBTransaction ATransaction)
	The operator is going to set 1, (period + 1). 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

If a procedure is defined which shall be assigned inside a specific perodic process you have to use this class the handle the operation itself and the AbstractPeriodEndOperation class to handle the internal parts of the operation.
For example the class TMonthEnd and TYearEnd inherits TPeriodEndOperations.

Member Function Documentation

RunPeriodEndCheck()

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

inlineprotected

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  )

inlineprotected

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

Parameters

AOperation
AOperationName

SetNextPeriod()

abstract void Ict.Petra.Server.MFinance.Common.TPeriodEndOperations.SetNextPeriod ( TDBTransaction  ATransaction )

pure virtual

The operator is going to set 1, (period + 1).

Implemented in Ict.Petra.Server.MFinance.GL.TMonthEnd, Ict.Petra.Server.MFinance.GL.TYearEnd, and Ict.Testing.Petra.Server.MFinance.GL.TestOperations.

Member Data Documentation

FHasCriticalErrors

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

protected

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

protected

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

protected

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

Property Documentation

WasCancelled

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

staticgetset

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

---

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

• csharp/ICT/Petra/Server/lib/MFinance/Common/Common.PeriodEnd.cs