Table of Contents

Class Task

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

Base class for Tasks run by JobSteps

public abstract class Task : ADTObject
Inheritance
object
Task
Derived

Remarks

A Task can only be assigned to a single JobStep; tasks cannot be shared.

Properties

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.

DescriptionOverride

Override for the system-generated description of the object

public string DescriptionOverride { get; set; }

Property Value

string

Remarks

This property is for use by user interface extensions

JobStep 

public JobStep JobStep { get; }

Property Value

JobStep

SupportedResponseEvents

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

public abstract ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

UserInterfaceExtensionData

Extension data for the customer user interface for this object

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

Extension ID of the customer user interface for this object

public string UserInterfaceExtensionID { 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.

GetStandardSupportedResponseEvents()

Gets the response events that are supported for all task types.

protected static List<SupportedResponseEvent> GetStandardSupportedResponseEvents()

Returns

List<SupportedResponseEvent>

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