Table of Contents

Class JobStep

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

Represents a step within a job

public sealed class JobStep : ADTObject, ISupportJobVariables
Inheritance
object
JobStep
Implements

Remarks

To create a new step use CreateObject(ClassID)

Each Step can only belong to a single job.

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.

ConditionFailureAction

Action to take if one or more Conditions fails

public ConditionFailureOptions ConditionFailureAction { get; set; }

Property Value

ConditionFailureOptions

ConditionRule

Determines how Conditions are evaluated

public ConditionRule ConditionRule { get; set; }

Property Value

ConditionRule

Conditions

The conditions that must be met before the step executes

public ConditionCollection Conditions { get; }

Property Value

ConditionCollection

Enabled

Determines whether the step is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If a step is disabled, (Enabled set to false the step is skipped during job execution)

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.

Job

Gets the job this step belongs to

public Job Job { get; }

Property Value

Job

Remarks

The Job cannot be updated directly; it is set when the step is added to the job's Steps collection.

JobVariables

The job variables defined for the step

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

Remarks

This collection only contains the variables defined explicitly for the step. Use GetInheritedVariables(bool) to retrieve variables inherited from higher levels (server, group, queue, job).

To override a variable set at a higher level, add a new variable to this collection with the same name and the desired value.

Name

Optional name for the step

public string Name { get; set; }

Property Value

string

Responses

The responses that are defined for this step

public ResponseCollection Responses { get; }

Property Value

ResponseCollection

Remarks

This collection contains only the responses defined explicitly for the step. The step will also execute responses inherited from the Group, Queue, and Job.

StepNumber

The numeric step number

public int StepNumber { get; }

Property Value

int

Remarks

The StepNumber is assigned automatically based on the order of steps in the job's Steps collection.

Task

The Task that the step executes

public Task Task { get; set; }

Property Value

Task

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.

GetDescription(bool)

Gets a description of the step, optionally prefixing it with the StepNumber

public string GetDescription(bool includeStepNumber)

Parameters

NameTypeDescription
includeStepNumber bool

Returns

string

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

If true the returned collection contains both inherited variables and variables defined at this level. If false the results only include inherited variables.

Returns

JobVariableCollection

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

See Also

Steps