Class SplitProcessParameter
The server task parameters for the split transaction calculation process
Inherits from the transaction item server task parameter which records the id and label of the ISplitTransaction 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 SplitProcessParameter : TransactionItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<SplitProcessParameter>Constructors
SplitProcessParameter()
Creates a new split transaction server task process parameter
Declaration
public SplitProcessParameter()SplitProcessParameter(IBaseEntity)
Creates a new split transaction server task process parameter for the specified blended transaction
Declaration
public SplitProcessParameter(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item | An ISplitTransaction this parameter will make the task run against |
Fields
UNIQUE_TASK_ID
The unique id of the split transaction calculation server task
Declaration
public const string UNIQUE_TASK_ID = "D59BA82B-3E8F-42BC-BD98-BE68E4B5595A"Field Value
| Type | Description |
|---|---|
| string |
Properties
CancelSourceTransaction
Indicates the split transaction should cancel the source trasnsaction when processing
Declaration
public bool CancelSourceTransaction { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Clone()
Creates a new instance of this class (of type SplitProcessParameter) with all the same property values as this instance
Declaration
public SplitProcessParameter Clone()Returns
| Type | Description |
|---|---|
| SplitProcessParameter | 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(SplitProcessParameter)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(SplitProcessParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| SplitProcessParameter | 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 split transaction recalculation task against the specified split transaction
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the split transaction |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is a split transaction recalculation task against the specified split transaction |