Table of Contents

Class JobStep

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class JobStep : ADTObject, ISequencedCollectionMember
Inheritance
object
JobStep
Implements

Properties

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

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

public ConditionFailureOptions ConditionFailureAction { get; set; }

Property Value

ConditionFailureOptions

ConditionRule

public ConditionRule ConditionRule { get; set; }

Property Value

ConditionRule

ConditionScript

public Script ConditionScript { get; set; }

Property Value

Script

Conditions

public ConditionCollection Conditions { get; }

Property Value

ConditionCollection

Description

public string Description { get; set; }

Property Value

string

Enabled

public bool Enabled { get; set; }

Property Value

bool

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

JobVariables

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

Name

public string Name { get; set; }

Property Value

string

ResourceFailureAction

public ResourceFailureAction ResourceFailureAction { get; set; }

Property Value

ResourceFailureAction

ResourceWaitLimit

public int ResourceWaitLimit { get; set; }

Property Value

int

Responses

public ResponseCollection Responses { get; }

Property Value

ResponseCollection

StepNumber

public int StepNumber { get; }

Property Value

int

Task

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.

GetInheritedVariables(bool)

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

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.

See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members