Class ScheduledOperation

Abstract base class for scheduled operations, which are long running tasks that are executed on the Execution Server.

Inheritance

object

ScheduledOperation

ImportExportOperationBase

ScheduledRecomputeStatisticsOperation

ScheduledReindexOperation

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public abstract class ScheduledOperation

Properties

CancelledOn

Gets when the operation was cancelled if the Status is Cancelled.

Declaration

public DateTime? CancelledOn { get; }

Property Value

Type	Description
DateTime?

CompletedOn

Gets when the operation was completed.

Declaration

public DateTime? CompletedOn { get; }

Property Value

Type	Description
DateTime?

ErrorMessage

Gets the error message in case the Status is Error.

Declaration

public string ErrorMessage { get; }

Property Value

Type	Description
string

IsFinished

Gets a value indicating whether this operation has finished.

Declaration

public bool IsFinished { get; }

Property Value

Type	Description
bool

Remarks

A finished operation has one of the following statues; Completed, Aborted, Cancelled, Recovered or Error.

IsPending

Gets a value indicating whether this operation is pending.

Declaration

public bool IsPending { get; }

Property Value

Type	Description
bool

Remarks

A pending operation has one of the following statues; NotSet, Queued, Cancel, Abort or Recovery.

IsRunning

Gets a value indicating whether this operation is running.

Declaration

public bool IsRunning { get; }

Property Value

Type	Description
bool

Remarks

A running operation has one of the following statues; Aborting, Allocated or Cancelling.

PercentComplete

Gets the current percent complete.

Declaration

public int PercentComplete { get; }

Property Value

Type	Description
int

QueuedOn

Gets when the operation was queued.

Declaration

public DateTime? QueuedOn { get; }

Property Value

Type	Description
DateTime?

StartedOn

Gets when the operation was started by the Execution Server.

Declaration

public DateTime? StartedOn { get; }

Property Value

Type	Description
DateTime?

Status

Gets the current status of the operation.

Declaration

public ScheduledOperationStatus Status { get; }

Property Value

Type	Description
ScheduledOperationStatus

WorkItemId

Gets the unique ID of the Execution Server work item that represents this operation.

Declaration

public Guid? WorkItemId { get; }

Property Value

Type	Description
Guid?

Methods

Queue()

Queues the operation for execution on the Execution Server.

Declaration

public abstract void Queue()

Refresh()

Refreshes the status of the operation.

Declaration

public abstract void Refresh()