Table of Contents

Class VariableUpdateAction

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class VariableUpdateAction : ResponseAction, ISequencedCollectionMember, IVariableUpdateTaskOrAction
Inheritance
object
VariableUpdateAction
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

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

GetActionDescription()

protected override string GetActionDescription()

Returns

string

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members