Interface IHasSaveProcessingTask

Indicates this entity when saved can create an associated task to finish processing the save.

This task is created during the save by a processor implementing IBaseDataSetProcessorWithDBSave

See Processors.Transactional.BaseTransactionProcessor for more info

This is used by a client to notice that although the save is complete, a task has been automatically created for processing the rest of this task, and it can track that task for final completion. When the task is completing one of the steps is to set this back to null.

Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: LemonEdge.API.dll
Syntax
public interface IHasSaveProcessingTask : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

PriorRunTaskParam

Holds the task parameters used when this was previously run. SavedTaskParam is cleared after processing to distinguish between imports and other operations.

Declaration
[EntityProperty(SQLType.VarBinary, true)]
[EntityDescription("Holds the task parameters used when this was previously run. SavedTaskParam is cleared after processing to distinguish between imports and other operations.")]
[SetItemClearOnCopy]
byte[] PriorRunTaskParam { get; set; }
Property Value
Type Description
byte[]

SavedTaskID

Links to IServerTask. Indicates the task that has been automatically created during the save process for completing any further processing

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("Holds the task automatically created for processing during a modification.")]
[EntityRelationship(EntityID.ServerTask, "ID", SingleJoinType.ZeroToOne, "Saved Processing Task", "Items Processed On Save")]
[SetItemClearOnCopy]
Guid? SavedTaskID { get; set; }
Property Value
Type Description
Guid?

SavedTaskParam

Holds the associated parameters for the task SavedTaskID

Declaration
[EntityProperty(SQLType.VarBinary, true)]
[EntityDescription("The parameters for running the task automatically created for processing during a modification. This is cleared out once run.")]
[SetItemClearOnCopy]
byte[] SavedTaskParam { get; set; }
Property Value
Type Description
byte[]

Methods

GetShouldAutoGenerateTaskOnSave()

Indicates if the task should automatically be generated on save

Only runs on the service, or directly connected to db. Defaults to true

So ensure processors that implement IBaseDataSetProcessorWithDBSave correctly set this for the task to be auto created or not on save
Declaration
bool GetShouldAutoGenerateTaskOnSave()
Returns
Type Description
bool

If the task should automatically be generated on save

SetAutoGenerateOnSave(bool)

Sets if thie task should be generated for this item on save or not

Declaration
void SetAutoGenerateOnSave(bool value)
Parameters
Type Name Description
bool value

Indicates if the task should be generated on save or not

Extension Methods