Class FinaliseTransactionsTask
A server task that finalises transactions that have been committed and are up to date for the specified entity
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Tasks.Process
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
[ServerTask("Finalise Transacations", "19d13c67-d993-41eb-bffc-271be201f6f3", typeof(FinaliseTransactionsParameter), Description = "List or finalise transactions for the specified entity and up to date.")]
public class FinaliseTransactionsTask : ITaskProcessor, IProcessor, IDisposableConstructors
FinaliseTransactionsTask(ITransactionsFinaliser)
Declaration
public FinaliseTransactionsTask(ITransactionsFinaliser transactionsFinaliser)Parameters
| Type | Name | Description |
|---|---|---|
| ITransactionsFinaliser | transactionsFinaliser |
Properties
Cache
A local cache for performance
Declaration
public IReadOnlyCache Cache { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyCache |
Parameter
Declaration
public FinaliseTransactionsParameter Parameter { get; }Property Value
| Type | Description |
|---|---|
| FinaliseTransactionsParameter |
Reporter
A reporter to provide feedback to a log, or client depending on the context the process is running under
Declaration
public BusyProgressReporter Reporter { get; set; }Property Value
| Type | Description |
|---|---|
| BusyProgressReporter |
Updater
A context to ensure the process can query, load and modify all LemonEdge data
Declaration
public IEntityUpdater Updater { get; }Property Value
| Type | Description |
|---|---|
| IEntityUpdater |
User
The current logged in user the process is running under
Declaration
public UserInfo User { get; }Property Value
| Type | Description |
|---|---|
| UserInfo |
Methods
Dispose()
Declaration
public void Dispose()Dispose(bool)
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
Init(ITaskRunner, ServerTaskParameter)
Initializes the task processor with the parameters for processing the task
Declaration
public Task Init(ITaskRunner runner, ServerTaskParameter ProcessTaskParameter)Parameters
| Type | Name | Description |
|---|---|---|
| ITaskRunner | runner | The context within which the task is being processed |
| ServerTaskParameter | ProcessTaskParameter | The parameter for running this task |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operationn |
ProcessTask(CancellationToken)
A function that implements the process for this task using the parameters provided during Init(ITaskRunner, ServerTaskParameter)
Declaration
public Task<object> ProcessTask(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | A cancellation token for cancelling any long running task |
Returns
| Type | Description |
|---|---|
| Task<object> | An optional object detailing the result which can be converted using ITaskResultHandler into a ServerTaskResult, or is a ServerTaskResult itself |