Table of Contents

Class JobExecutionTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class JobExecutionTask : Task
Inheritance
object
JobExecutionTask

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.

ExecutionOptions 

public JobExecutionOptions ExecutionOptions { get; set; }

Property Value

JobExecutionOptions

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.

MaximumDispatchWaitTime 

public TimeSpan? MaximumDispatchWaitTime { get; set; }

Property Value

TimeSpan?

MaximumRunTime 

public TimeSpan? MaximumRunTime { get; set; }

Property Value

TimeSpan?

SkipIfAlreadyRunning 

public bool SkipIfAlreadyRunning { get; set; }

Property Value

bool

SuccessRule 

public JobExecutionTaskSuccessRule SuccessRule { get; set; }

Property Value

JobExecutionTaskSuccessRule

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

Targets 

public JobExecutionTaskTargetCollection Targets { get; }

Property Value

JobExecutionTaskTargetCollection

WaitType 

public JobExecutionTaskWaitType WaitType { get; set; }

Property Value

JobExecutionTaskWaitType

Methods

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