Class StepChangeProcessParameter
Inheritance
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Tasks.Parameters
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
[DataContract]
public class StepChangeProcessParameter : TransactionItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<StepChangeProcessParameter>Constructors
StepChangeProcessParameter()
Creates a new step change transaction server task process parameter
Declaration
public StepChangeProcessParameter()StepChangeProcessParameter(IBaseEntity)
Creates a new step change transaction server task process parameter for the specified transfer
Declaration
public StepChangeProcessParameter(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item | An IStepChange this parameter will make the task run against |
Fields
UNIQUE_TASK_ID
The unique id of the step change calculation server task
Declaration
public const string UNIQUE_TASK_ID = "8F80D832-906B-4FC8-B0DE-F4662A18183D"Field Value
| Type | Description |
|---|---|
| string |
Properties
IncludeCommitted
Declaration
public bool IncludeCommitted { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
UpdateAllDates
Declaration
public bool UpdateAllDates { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Clone()
Creates a new instance of this class (of type StepChangeProcessParameter) with all the same property values as this instance
Declaration
public StepChangeProcessParameter Clone()Returns
| Type | Description |
|---|---|
| StepChangeProcessParameter | 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(StepChangeProcessParameter)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(StepChangeProcessParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| StepChangeProcessParameter | 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 step change transaction recalculation task against the specified step change
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the step change |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is a step change transaction recalculation task against the specified step change |