Table of Contents

Class VariableUpdateTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class VariableUpdateTask : Task, IVariableUpdateTaskOrAction
Inheritance
object
VariableUpdateTask
Implements

Properties

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

IncrementBy

The amount to increment or decrement by

public int IncrementBy { get; set; }

Property Value

int

IncrementType

The type of increment to use for UpdateType==SetBasedOnDate

public DayTimeInterval IncrementType { get; set; }

Property Value

DayTimeInterval

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

NewValue

The value or pattern to use to set the variable.

public string NewValue { get; set; }

Property Value

string

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

TargetObject

The object to be updated if the UpdateScope is VariableUpdateScope.Targeted.

public ADTObject TargetObject { get; set; }

Property Value

ADTObject

TargetVariable

The name of the variable to update

public string TargetVariable { get; set; }

Property Value

string

UpdateScope

public VariableUpdateScope UpdateScope { get; set; }

Property Value

VariableUpdateScope

UpdateType

public VariableUpdateType UpdateType { get; set; }

Property Value

VariableUpdateType

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members