Table of Contents

Class Response

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

A Response defines a set of actions to execute when specified events occur during job execution.

public sealed class Response : ADTObject
Inheritance
object
Response

Remarks

A Response consists of a collection of Events that define the circumstances under which the Response is triggered and Actions that define the actions to be taken. The Response is triggered if any of the Events occurs. Once the Response is triggered, all of the Actions are executed in the order defined by their Sequence.

Properties

Actions

The actions executed when the Response is triggered

public ResponseActionCollection Actions { get; }

Property Value

ResponseActionCollection

Remarks

When the Response is triggered all of the Actions are executed in sequence.

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.

Enabled

Indicates whether this Response is enabled.

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the Response is not enabled it is ignored.

Events

Collection of events defining the conditions that cause the Response to execute

public ResponseEventCollection Events { get; }

Property Value

ResponseEventCollection

Remarks

The Response is triggered whenever any of the defined Events occur.

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.

Name

Optional name for the Response

public string Name { get; set; }

Property Value

string

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