Table of Contents

Class FileOperationTask

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

Task that performs file operations (copy, move, etc.)

public sealed class FileOperationTask : Task
Inheritance
object
FileOperationTask

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.

ClassName

Returns a descriptive name for the class suitable for display to users.

public override string ClassName { get; }

Property Value

string

Remarks

For example, "Job" or "Program Execution Task".

EncryptedData1Set

Indicates whether encrypted data value 1 has been set

public bool EncryptedData1Set { get; }

Property Value

bool

EncryptedData2Set

Indicates whether encrypted data value 2 has been set

public bool EncryptedData2Set { get; }

Property Value

bool

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.

OperationType

The type of operation performed by this task

public string OperationType { get; }

Property Value

string

Remarks

The OperationType indicates the OperationType of the TaskSettings

SourceServiceProvider

The FileServiceProvider (if any) where the source files are located

public FileServiceProvider SourceServiceProvider { get; set; }

Property Value

FileServiceProvider

Remarks

Set to null when no file service provider is required (e.g., for local files)

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>

TargetServiceProvider

The FileServiceProvider (if any) where the target files are located

public FileServiceProvider TargetServiceProvider { get; set; }

Property Value

FileServiceProvider

Remarks

Set to null when no file service provider is required (e.g., for local files)

TaskSettings

The settings for this task

public FileOperationTaskSettings TaskSettings { get; set; }

Property Value

FileOperationTaskSettings

Remarks

The TaskSettings will be one of the specialized settings classes derived from FileOperationTaskSettings, depending on the type of operation this task performs.

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.

SetEncryptedData1(string)

Used to store encrypted data value 1 if required by the settings

public void SetEncryptedData1(string value)

Parameters

NameTypeDescription
value string

SetEncryptedData2(string)

Used to store encrypted data value 2 if required by the settings

public void SetEncryptedData2(string value)

Parameters

NameTypeDescription
value string

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