Class PeriodEndProcessParameter
The period end parameters for the period end calculation process
Inherits from the transaction item server task parameter which records the id and label of the IPeriodEnd 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 PeriodEndProcessParameter : TransactionItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<PeriodEndProcessParameter>Constructors
PeriodEndProcessParameter()
Creates a new period end transaction server task process parameter
Declaration
public PeriodEndProcessParameter()PeriodEndProcessParameter(IBaseEntity)
Creates a new perioed end server task process parameter for the specified period end
Declaration
public PeriodEndProcessParameter(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item | An IPeriodEnd this parameter will make the task run against |
Fields
UNIQUE_TASK_ID
The unique id of the perioed end transaction calculation server task
Declaration
public const string UNIQUE_TASK_ID = "d8592592-d980-45ac-b649-b9416752112a"Field Value
| Type | Description |
|---|---|
| string |
Properties
CloseAllEntities
Declaration
public bool CloseAllEntities { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
FinalisePriodEndTransactionsType
Declaration
public FinalisePeriodEndTransactionsType FinalisePriodEndTransactionsType { get; set; }Property Value
| Type | Description |
|---|---|
| FinalisePeriodEndTransactionsType |
FinalizeAllCommitted
Declaration
public bool FinalizeAllCommitted { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeCommitted
Indicates if committed transactions should be included or not
Declaration
public bool IncludeCommitted { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeRetainedEarnings
Declaration
public bool IncludeRetainedEarnings { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeUnderlyingDynamicallyAllocatedAmounts
Declaration
public bool IncludeUnderlyingDynamicallyAllocatedAmounts { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
Clone()
Creates a new instance of this class (of type PeriodEndProcessParameter) with all the same property values as this instance
Declaration
public PeriodEndProcessParameter Clone()Returns
| Type | Description |
|---|---|
| PeriodEndProcessParameter | 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(PeriodEndProcessParameter)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(PeriodEndProcessParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| PeriodEndProcessParameter | 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 period end recalculation task against the specified period end transaction
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)Parameters
| Type | Name | Description |
|---|---|---|
| IServerTask | task | The server task for processing the period end |
Returns
| Type | Description |
|---|---|
| string | A string stating that this is a period end recalculation task against the specified period end transaction |