Class FinaliseTransactionsParameter
The server task parameters for the finalise transactions task
Inherits from the item server task parameters which records params for transactions to finalise
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Tasks.Parameters
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
[DataContract]
public class FinaliseTransactionsParameter : ServerTaskParameter, ICloneable, ICloneable<FinaliseTransactionsParameter>Constructors
FinaliseTransactionsParameter()
Declaration
public FinaliseTransactionsParameter()Fields
UNIQUE_TASK_ID
Declaration
public const string UNIQUE_TASK_ID = "19d13c67-d993-41eb-bffc-271be201f6f3"Field Value
| Type | Description |
|---|---|
| string |
Properties
EntityID
EntityID for which to finalise transactions
Declaration
[DataMember]
public Guid EntityID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
EntityName
Name of the entity for which to finalise transactions
Declaration
[DataMember]
public string EntityName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
EntitySetID
Declaration
[DataMember]
public Guid EntitySetID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
FinaliseTransactionsType
Type of finalise transactions task
Declaration
[DataMember]
public FinaliseTransactionsType FinaliseTransactionsType { get; set; }Property Value
| Type | Description |
|---|---|
| FinaliseTransactionsType |
UpToDate
Up to date for which to finalise transactions
Declaration
[DataMember]
public DateTimeOffset UpToDate { get; set; }Property Value
| Type | Description |
|---|---|
| DateTimeOffset |
Methods
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(FinaliseTransactionsParameter)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(FinaliseTransactionsParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| FinaliseTransactionsParameter | 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 a user friendly string for the type of task being processed that these parameters work against
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | An instance of a task that these parameters work for |
Returns
| Type | Description |
|---|---|
| string | A user friendly string for the type of task being processed that these parameters work against |