Class PeriodEndProcessParameter
The period end parameters for the period end calculation processs
Inherits from the transaction item server task parameter which records the id and label of the IPeriodEnd this task should be calculated against
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.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 |
|---|---|
| System.String |
Properties
IncludeCommitted
Indicates if committed transactions should be included or not
Declaration
public bool IncludeCommitted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Clone()
Declaration
public PeriodEndProcessParameter Clone()Returns
| Type | Description |
|---|---|
| PeriodEndProcessParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)Parameters
| Type | Name | Description |
|---|---|---|
| SerializedParam | source |
Overrides
CopyFromSource(PeriodEndProcessParameter)
Declaration
public void CopyFromSource(PeriodEndProcessParameter source)Parameters
| Type | Name | Description |
|---|---|---|
| PeriodEndProcessParameter | source |
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()Returns
| Type | Description |
|---|---|
| SerializedParam |
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 |
|---|---|
| System.String | A string stating that this is a period end recalculation task against the specified period end transaction |