Table of Contents

Class ConditionStatus

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

Shows the status of a Condition.

[ComVisible(true)]
[Guid("7b20e90b-80fb-4be3-83c7-1af9542f0a7d")]
public sealed class ConditionStatus : ADTObject
Inheritance
object
ConditionStatus

Properties

AdditionalInformation

Additional information about the current status.

public string AdditionalInformation { get; }

Property Value

string

Remarks

This field may describe things such as the name that a file condition is waiting on, or the name of the file that satisfied the condition.

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.

ConditionDescription

A description of the condition.

public string ConditionDescription { get; }

Property Value

string

ConditionOID

The OID of the condition

public Guid ConditionOID { get; }

Property Value

Guid

ExecutionHistoryItem

The ExecutionHistoryItem representing the job instance to which this status belongs.

public ExecutionHistoryItem ExecutionHistoryItem { get; }

Property Value

ExecutionHistoryItem

ExecutionHistoryStep

The ExecutionHistoryStep representing the job step instance to which this status belongs.

public ExecutionHistoryStep ExecutionHistoryStep { get; }

Property Value

ExecutionHistoryStep

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.

Status

The status of the condition

public ConditionState Status { get; }

Property Value

ConditionState

StatusDescription

Gets the text description of the Status.

public string StatusDescription { get; }

Property Value

string

StepNumber

Gets the step number with which this status is associated.

public int StepNumber { get; }

Property Value

int

Remarks

Returns 0 if this is a job-level condition (ExecutionHistoryStep is also null)

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.

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