Table of Contents

Class TriggerStatus

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

Shows the state of a Trigger

public sealed class TriggerStatus : ADTObject
Inheritance
object
TriggerStatus

Remarks

Not all triggers currently report a status.

To get the status for a trigger use GetTriggerStatus(OID).

The status is current as of the time it is fetched through GetTriggerStatus and does not update automatically to reflect changes. To refresh the status, call GetTriggerStatus again.

Properties

AdditionalInformation

Additional information or message reported by the trigger

public string AdditionalInformation { get; }

Property Value

string

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.

Status

The state of the trigger

public TriggerState Status { get; }

Property Value

TriggerState

StatusDescription

A description of the Status

public string StatusDescription { get; }

Property Value

string

SubIdentifier

Additional identifying information

public string SubIdentifier { get; }

Property Value

string

TriggerDescription

Description of the trigger

public string TriggerDescription { get; }

Property Value

string

TriggerObjectID

The ObjectID of the OID of the trigger this status belongs to.

public Guid TriggerObjectID { get; }

Property Value

Guid

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