Table of Contents

Class VariableUpdateTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Task that updates the value of a JobVariable

public sealed class VariableUpdateTask : Task, IVariableUpdateTaskOrAction
Inheritance
object
VariableUpdateTask
Implements

Remarks

Depending on the value of the UpdateScope the update may affect only the running instance, or it may make a persistent change to the configuration.

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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 if the UpdateType is IncrementDecrement

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

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

NewValue

The value or pattern to use to set the variable.

public string NewValue { get; set; }

Property Value

string

Remarks

Can include variable tokens that get expanded at runtime.

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

Remarks

The TargetObject must be an object type that supports Job Variables,

TargetVariable

The name of the variable to update

public string TargetVariable { get; set; }

Property Value

string

UpdateScope

The scope where the update is applied.

public VariableUpdateScope UpdateScope { get; set; }

Property Value

VariableUpdateScope

UpdateType

The type of update to perform

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members