Table of Contents

Class CapturedFile

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

The CapturedFile class represents a file captured by adTempus due to a FileCaptureAction, NotificationAction, or programmatic capture by a script.

[ComVisible(true)]
[Guid("12235ef6-faa7-4d79-b385-cac7d2848679")]
public sealed class CapturedFile : ADTObject
Inheritance
object
CapturedFile

Fields

CapturedFileComparerStepNumberFileName

Comparer to order Captured Files by step number and file name.

public static readonly IComparer<CapturedFile> CapturedFileComparerStepNumberFileName

Field Value

IComparer<CapturedFile>

Properties

CaptureType

The type of capture action.

public string CaptureType { get; }

Property Value

string

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.

Description

A description of the file.

public string Description { get; }

Property Value

string

FileDate

The last modified timestamp of the file.

[ComVisible(false)]
public DateTime? FileDate { get; }

Property Value

DateTime?

FileSize

The size of the file

public long FileSize { get; }

Property Value

long

Instance 

public ExecutionHistoryItem Instance { get; }

Property Value

ExecutionHistoryItem

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.

OriginalFileName

The original name of the file.

public string OriginalFileName { get; }

Property Value

string

OriginalPath

The original path of the file.

public string OriginalPath { get; }

Property Value

string

Step 

public ExecutionHistoryStep Step { get; }

Property Value

ExecutionHistoryStep

StepNumber

Returns the StepNumber for the Step this item is associated with, or 0 if it is not associated with a step.

public int StepNumber { get; }

Property Value

int

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.

GetContents()

Retrieves the file data from the server and returns it as a byte array.

public byte[] GetContents()

Returns

byte[]

Remarks

This might not be a good idea for large files. Use WriteContentsToFile(string) or WriteContentsToStream(Stream) instead.

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Returns the Description if set or the OriginalFileName otherwise

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.

WriteContentsToFile(string)

Retrieves the file data from the server and returns it to a local file.

public void WriteContentsToFile(string fileName)

Parameters

NameTypeDescription
fileName string

WriteContentsToStream(Stream)

Retrieves the file data from the server and returns it to a stream.

public void WriteContentsToStream(Stream stream)

Parameters

NameTypeDescription
stream Stream

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