Table of Contents

Class Condition

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

Base class for all Conditions

public abstract class Condition : ADTObject
Inheritance
object
Condition
Derived

Properties

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.

DescriptionOverride

Description of the condition

public string DescriptionOverride { get; set; }

Property Value

string

Enabled

Indicates whether the condition is enabled.

public bool Enabled { get; set; }

Property Value

bool

Name

Optional name for the condition

public string Name { get; set; }

Property Value

string

PollingInterval

Time to wait between checks of the condition.

public TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

Remarks

Set to System.TimeSpan.Zero to use the default polling interval.

StaysTriggered

Determines whether the condition stays triggered (satisfied)

public bool StaysTriggered { get; set; }

Property Value

bool

Remarks

If true, adTempus stops evaluating the condition for the current instance of the job, even if other conditions remain to be satisfied. If false the condition gets reevaluated each time adTempus evaluates other conditions for the job.

UserInterfaceExtensionData

Additional data stored for the custom user interface

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

The extension ID of the custom user interface for this object

public string UserInterfaceExtensionID { get; set; }

Property Value

string

WaitLimit

Time to wait for the condition to be satisfied.

public TimeSpan WaitLimit { get; set; }

Property Value

TimeSpan

Remarks

Set to NoWait to not wait for the condition to be satisfied, or Infinite to wait until the condition is satisfied or the job is canceled

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetConditionDescription() 

protected abstract string GetConditionDescription()

Returns

string

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