Class TruncateEntityParameter

The server task parameters for the truncate entity calculation process

Truncates all the tables holding data for this entity, all froeign table entries linking to it are left.

Inheritance
object
SerializedParam
ServerTaskParameter
TruncateEntityParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Truncate Entity Table", "1DE9CF04-251D-4734-A489-151C531727F2", Description = "Truncates all the tables holding data for this entity, all froeign table entries linking to it are left.")]
public class TruncateEntityParameter : ServerTaskParameter, ICloneable, INotifyPropertyChanged

Constructors

TruncateEntityParameter()

Declaration
public TruncateEntityParameter()

Fields

UNIQUE_TASK_ID

The unique id of the upgrade database server task

Declaration
public const string UNIQUE_TASK_ID = "1DE9CF04-251D-4734-A489-151C531727F2"
Field Value
Type Description
string

Properties

EntityTypeID

The type of entity to truncate all data in the table for

Declaration
public Guid EntityTypeID { get; set; }
Property Value
Type Description
Guid

Methods

Clone()

Declaration
public TruncateEntityParameter Clone()
Returns
Type Description
TruncateEntityParameter

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(TruncateEntityParameter)

Declaration
public void CopyFromSource(TruncateEntityParameter source)
Parameters
Type Name Description
TruncateEntityParameter source

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 truncate entity server task

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing the truncate entity
Returns
Type Description
string

A string stating that this is a truncate entity server task
Overrides

OnPropChanged(string)

Declaration
protected void OnPropChanged(string propName)
Parameters
Type Name Description
string propName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods