Table of Contents

Class FileOperationTaskSettings

Namespace
ArcanaDevelopment.adTempus.Shared.FileOperations
Assembly
ArcanaDevelopment.adTempus.Shared.dll
[DataContract]
public abstract class FileOperationTaskSettings
Inheritance
object
FileOperationTaskSettings
Derived

Properties

BackupBeforeOverwrite

If true, a copy of the existing file is made before it is replaced.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool BackupBeforeOverwrite { get; set; }

Property Value

bool

ClearArchiveFlag

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool ClearArchiveFlag { get; set; }

Property Value

bool

ExcludeFiles

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public List<string> ExcludeFiles { get; }

Property Value

List<string>

IncludeFiles

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember(Name = "Files")]
public List<string> IncludeFiles { get; }

Property Value

List<string>

MaintainDirectoryStructure

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool MaintainDirectoryStructure { get; set; }

Property Value

bool

ModifiedWithin

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public TimeSpan? ModifiedWithin { get; set; }

Property Value

TimeSpan?

OperationType

public abstract string OperationType { get; }

Property Value

string

OverwriteOption

[DataMember]
[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
public FileOverwriteOption OverwriteOption { get; set; }

Property Value

FileOverwriteOption

SelectArchiveFlagOnly

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool SelectArchiveFlagOnly { get; set; }

Property Value

bool

SelectModifiedSince

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public DateTime? SelectModifiedSince { get; set; }

Property Value

DateTime?

SelectModifiedSinceVariable

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string SelectModifiedSinceVariable { get; set; }

Property Value

string

SourceDirectory

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string SourceDirectory { get; set; }

Property Value

string

SourceRecursive

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool SourceRecursive { get; set; }

Property Value

bool

TargetName

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string TargetName { get; set; }

Property Value

string

Methods

CreateDefinition(string)

public static FileOperationTaskSettings CreateDefinition(string operationType)

Parameters

NameTypeDescription
operationType string

Returns

FileOperationTaskSettings

DeserializeDefinition(string, string)

Deserializes a definition to the correct type based on the operationType.

public static FileOperationTaskSettings DeserializeDefinition(string operationType, string serializedData)

Parameters

NameTypeDescription
operationType string
serializedData string

Returns

FileOperationTaskSettings

Exceptions

ArgumentOutOfRangeException

Thrown if the operationType is not recognized.

DoValidation(MessageCollection)

public virtual void DoValidation(MessageCollection messages)

Parameters

NameTypeDescription
messages MessageCollection

GetConfigurationDescription(FileOperationTaskInformation)

public abstract string GetConfigurationDescription(FileOperationTaskInformation ownerInfo)

Parameters

NameTypeDescription
ownerInfo FileOperationTaskInformation

Returns

string