Ict.Petra.Server.App.Core.TProgressTracker Class Reference

tracks the progress for long running jobs More...

Static Public Member Functions
static TProgressState	InitProgressTracker (string AClientID, string ACaption, decimal AAbsoluteOverallAmount=100.0m)
	add or reuse a tracker for the given clientID More...
static TProgressState	GetCurrentState (string AClientID)
	get the current state, by clientID More...
static void	SetCurrentState (string AClientID, string AStatusMessage, Decimal ACurrentAbsoluteAmount)
	set the current state More...
static bool	CancelJob (string AClientID)
	the client can cancel the job More...
static bool	FinishJob (string AClientID)
	the server will set the job to finished More...

Detailed Description

tracks the progress for long running jobs

Member Function Documentation

CancelJob()

static bool Ict.Petra.Server.App.Core.TProgressTracker.CancelJob ( string  AClientID )

inlinestatic

the client can cancel the job

Parameters

AClientID

FinishJob()

static bool Ict.Petra.Server.App.Core.TProgressTracker.FinishJob ( string  AClientID )

inlinestatic

the server will set the job to finished

GetCurrentState()

static TProgressState Ict.Petra.Server.App.Core.TProgressTracker.GetCurrentState ( string  AClientID )

inlinestatic

get the current state, by clientID

Parameters

AClientID

Returns

InitProgressTracker()

static TProgressState Ict.Petra.Server.App.Core.TProgressTracker.InitProgressTracker ( string  AClientID, string  ACaption, decimal  AAbsoluteOverallAmount = 100.0m  )

inlinestatic

add or reuse a tracker for the given clientID

Parameters

AClientID
ACaption
AAbsoluteOverallAmount

Returns

SetCurrentState()

static void Ict.Petra.Server.App.Core.TProgressTracker.SetCurrentState ( string  AClientID, string  AStatusMessage, Decimal  ACurrentAbsoluteAmount  )

inlinestatic

set the current state

Parameters

AClientID
AStatusMessage
ACurrentAbsoluteAmount

---

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

• csharp/ICT/Petra/Server/app/Core/ProgressTracker.cs