Table of Contents

Class ScriptCondition

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

A Condition that depends on the result of a script.

public sealed class ScriptCondition : Condition
Inheritance
object
ScriptCondition

Remarks

The Script must return true to indicate that the condition is satisfied and execution can continue, or false to indicate that the condition is not satisfied.

The script will be executed repeatedly at the interval specified by PollingInterval until the condition is satisfied.

Be sure to set the StaysTriggered property appropriately. If StaysTriggered is false and other conditions are defined, the script will be continue to be executed each time the condition is polled (even if it has previously returned true) as long as other conditions remain unsatisfied.

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.

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.

Options

Options controlling the behavior of the condition

public ScriptConditionOptions Options { get; set; }

Property Value

ScriptConditionOptions

Script

The Script to execute

public Script Script { get; set; }

Property Value

Script

Remarks

See the general Remarks under ScriptCondition for more information.

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