Class GroupProductRelationScheduledTaskAddIn

Namespace

Dynamicweb.Ecommerce.Products.ScheduledTaskAddIns

Assembly

Dynamicweb.Ecommerce.dll

Scheduled task provider GroupProductRelationScheduledTaskAddIn makes it possible to automatically assign products to one or more groups, depending on some rules which are based on some values on the product.

[AddInName("Dynamicweb.Scheduling.GroupProductRelationAddIn")]
[AddInLabel("Assign products to one or more groups, depending on some rules")]
[AddInDescription("Assign products to one or more groups, depending on some rules")]
public class GroupProductRelationScheduledTaskAddIn : BaseScheduledTaskAddIn, IParameterOptions

Inheritance

object

ConfigurableAddIn

BaseScheduledTaskAddIn

GroupProductRelationScheduledTaskAddIn

Implements

IParameterOptions

Inherited Members

BaseScheduledTaskAddIn.ScheduledTaskName

BaseScheduledTaskAddIn.Task

BaseScheduledTaskAddIn.CancellationToken

BaseScheduledTaskAddIn.IsCancellationTokenUsed

BaseScheduledTaskAddIn.HostUrl

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AssignmentRules

[AddInLabel("Assignment rules")]
[AddInParameter("AssignmentRules")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=All rules;rightheader=Selected rules;translateheaders=true;showsearchbox=true")]
public string? AssignmentRules { get; set; }

Property Value

string

DoNotDetachProducts

[AddInLabel("Don't detach products")]
[AddInParameter("DoNotDetachProducts")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "inputClass=inputControl")]
public bool DoNotDetachProducts { get; set; }

Property Value

bool

Methods

Run()

Performs the work of the scheduled task. Called once per task run, after the framework has populated the context properties and loaded the saved parameter values.

public override bool Run()

Returns

bool

true when the work succeeded; otherwise false. The value is logged and stored as the task's last result. Exceptions that escape this method are caught by the framework, logged, and recorded as a failed run.