Class TransferProcessParameter
The server task parameters for the transfer calculation process
Inherits from the transaction item server task parameter which records the id and label of the ITransfer this task should be calculated against
Inheritance
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Tasks.Parameters
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
[DataContract]
public class TransferProcessParameter : TransactionItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<TransferProcessParameter>Constructors
TransferProcessParameter()
Creates a new transfer transaction server task process parameter
Declaration
public TransferProcessParameter()TransferProcessParameter(IBaseEntity)
Creates a new transfer transaction server task process parameter for the specified transfer
Declaration
public TransferProcessParameter(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item | An ITransfer this parameter will make the task run against |
Fields
UNIQUE_TASK_ID
The unique id of the transfer calculation server task
Declaration
public const string UNIQUE_TASK_ID = "3f605df5-b5fb-4a0c-929e-c787a76ebfb9"Field Value
| Type | Description |
|---|---|
| string |
Properties
IncludeCommitted
Indicates if committed transactions should be included or not
Declaration
public bool IncludeCommitted { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Clone()
Creates a new instance of this class (of type TransferProcessParameter) with all the same property values as this instance
Declaration
public TransferProcessParameter Clone()Returns
| Type | Description |
|---|---|
| TransferProcessParameter | A new instance of this class with all the same property values as this instance |
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()
CopyFromSource(TransferProcessParameter)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(TransferProcessParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| TransferProcessParameter | source | The source object to copy all values from. |
CreateNewParam()
Must be implemented by inheriting classes to provide a new instance of the current class type.
Used when cloning this SerializedParam to create a new instance of the same type
Declaration
protected override SerializedParam CreateNewParam()Returns
| Type | Description |
|---|---|
| SerializedParam | A new instance of the current SerializedParam type |
Overrides
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns that this is a transfer transaction recalculation task against the specified transfer
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the transfer |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is a transfer transaction recalculation task against the specified transfer |