Table of Contents

Class VariableCondition

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

A Condition that depends on the value of a JobVariable

public sealed class VariableCondition : Condition
Inheritance
object
VariableCondition

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.

CompareToValue

The value to compare to.

public string CompareToValue { get; set; }

Property Value

string

Remarks

You may compare to the value of another variable by specifying a standard variable token, e.g., "%somevariable%".

This value is treated as a string the comparison is a string comparison unless VariableType is set

ComparisonOperator

The comparison type to use.

public ComparisonOperator ComparisonOperator { get; set; }

Property Value

ComparisonOperator

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.

TargetVariable

The name of the variable to check

public string TargetVariable { get; set; }

Property Value

string

TextMatchRule

The comparison type to use for text comparisons.

public TextMatchRule TextMatchRule { get; set; }

Property Value

TextMatchRule

UseRegularExpression

Indicates whether the CompareToValue is a regular expression

public bool UseRegularExpression { get; set; }

Property Value

bool

VariableType

The data type of the CompareToValue

public JobVariableType VariableType { get; set; }

Property Value

JobVariableType

Methods

GetConditionDescription() 

protected override string GetConditionDescription()

Returns

string

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