Class TransactionItemParameter
A base server task parameter class that can be inherited by server tasks that process algorithms against transactional entities in the system
This allows the selection of the transaction entity in the system for the task to run against
Inheritance
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Tasks.Parameters
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
[DataContract]
public abstract class TransactionItemParameter : ItemParameter, ICloneable, INotifyPropertyChangedConstructors
TransactionItemParameter()
Creates a new transaction item parameter server task process parameter
Declaration
public TransactionItemParameter()TransactionItemParameter(ITransactionalEntity)
Creates a new transaction item server task process parameter for the item
Declaration
public TransactionItemParameter(ITransactionalEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| ITransactionalEntity | item | An transactional item this parameter will make the task run against |
Properties
AllowAutoCreateOnLockedItems
Returns true by default indicating the process allows tasks to run against finalized transactions
Declaration
protected override bool AllowAutoCreateOnLockedItems { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Recalculate
Indicates if the transaction process task should fully recalculate
Declaration
public bool Recalculate { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Status
Holds the status of the transactional item that it should be updated to
Declaration
public TransactionStatus Status { get; set; }Property Value
| Type | Description |
|---|---|
| TransactionStatus |
Methods
AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask, IEntityUpdater)
Indicates if the transaction process task should fully recalculate
Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The transactional item that has been modified |
| IEntityUpdater | context | The current context that it has been modified within |
Returns
| Type | Description |
|---|---|
| bool | True if the current status of the transactional item is less than finalized |
Overrides
CopyFromParam(SerializedParam)
Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified
source
Declaration
protected override void CopyFromParam(SerializedParam source)Parameters
| Type | Name | Description |
|---|---|---|
| SerializedParam | source | The source instance of a SerializedParam that is of the same type as this one to copy parameter values from |
Overrides
Remarks
Used by the generic implementation of Clone()
DisplayUserParamOnSave(IHasSaveProcessingTask, IEntityUpdater)
Holds the status of the transactional item that it should be updated to
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item, IEntityUpdater context)Parameters
| Type | Name | Description |
|---|---|---|
| IHasSaveProcessingTask | item | The transactional item that has been modified |
| IEntityUpdater | context | The current context that it has been modified within |
Returns
| Type | Description |
|---|---|
| bool | True if the current status of the transactional item is less than finalized |