Class TransactionItemParameter

A base server task parameter class that can be inherited by server tasks that process algorithms against transactional entities in the system

This allows the selection of the transaction entity in the system for the task to run against

Inheritance
System.Object
SerializedParam
ServerTaskParameter
ItemParameter
TransactionItemParameter
BlendProcessParameter
PeriodEndProcessParameter
TransferProcessParameter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
[DataContract]
public abstract class TransactionItemParameter : ItemParameter, ICloneable, INotifyPropertyChanged

Constructors

TransactionItemParameter()

Creates a new transaction item parameter server task process parameter

Declaration
public TransactionItemParameter()

TransactionItemParameter(ITransactionalEntity)

Creates a new transaction item server task process parameter for the item

Declaration
public TransactionItemParameter(ITransactionalEntity item)
Parameters
Type Name Description
ITransactionalEntity item

An transactional item this parameter will make the task run against

Properties

AllowAutoCreateOnLockedItems

Returns true by default indicating the process allows tasks to run against finalized transactions

Declaration
protected override bool AllowAutoCreateOnLockedItems { get; }
Property Value
Type Description
System.Boolean
Overrides

Recalculate

Indicates if the transaction process task should fully recalculate

Declaration
public bool Recalculate { get; set; }
Property Value
Type Description
System.Boolean

Status

Holds the status of the transactional item that it should be updated to

Declaration
public TransactionStatus Status { get; set; }
Property Value
Type Description
TransactionStatus

Methods

AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask)

Returns true if the current status of the transactional item is less than finalized

Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item)
Parameters
Type Name Description
IHasSaveProcessingTask item

The transactional item that has been modified
Returns
Type Description
System.Boolean

True if the current status of the transactional item is less than finalized
Overrides

CopyFromParam(SerializedParam)

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source
Overrides

DisplayUserParamOnSave(IHasSaveProcessingTask)

Returns true if the current status of the transactional item is less than finalized

Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item)
Parameters
Type Name Description
IHasSaveProcessingTask item

The transactional item that has been modified
Returns
Type Description
System.Boolean

True if the current status of the transactional item is less than finalized
Overrides

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods