Click or drag to resize

ITaskProcessingJobTDirective Interface

Interface received by task processing methods.

Namespace:  MFiles.VAF.AppTasks
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
Syntax
public interface ITaskProcessingJob<TDirective>
where TDirective : TaskDirective

Type Parameters

TDirective
The type of TaskDirective used by the task.

The ITaskProcessingJobTDirective type exposes the following members.

Properties
  NameDescription
Public propertyAbortJobToken
Token that signals if the job has been asked to abort.
Public propertyCancellationMessage
Message given for task cancellation, if it has been requested. Typically should be included in final status of the task if it marked canceled.
Public propertyCancelTaskToken
Token that signals if task cancellation has been requested.
Public propertyDirective
The task directive.
Public propertyIsJobAbortRequested
Indicates whether the job has been asked to abort.
Public propertyIsTaskCancellationRequested
Indicates whether it has been requested that the job's task is cancelled.
Public propertyRetries
The number of times this job has been retried.
Public propertyTaskInfo
The application task info.
Public propertyThrowOnUpdateBehavior
Public propertyTransactionMode
The transaction mode.
Public propertyVault
Vault access. Transaction scope is determined by the TransactionMode.
Top
Methods
  NameDescription
Public methodCommit
Used to finalize task processing in Hybrid mode. The callback runs in the scope of a vault transaction along with the final task completed state. If any part of the callback or task completion steps fail, all vault operations performed in the callback will be rolled back. Throws if called more than once. Throws if not in Hybrid mode.
Public methodGetStatus
Public methodThrowIfJobAbortRequested
Throws if the job has been asked to abort.
Public methodThrowIfTaskCancellationRequested
Throws if it has been requested that the job's task is cancelled.
Public methodTransaction
Runs a callback in the scope of a vault transaction. If the method fails, all operations made with the provided vault will be rolled back. If the method succeeds, all operations made with the provided vault will be committed.
Public methodUpdate
Updates the in-progress status of the task.
Top
Events
  NameDescription
Public eventCompleted
Triggered when the job either succeeds or fails.
Public eventFailed
Triggered when the job fails.
Public eventSaveTriggered
Triggered when the job was asked to commit it's progress/status to the vault. This can't always be done, even when triggered, due to risks of transaction lock conflicts, but this can be used to store progress data elsewhere in those cases.
Public eventSucceeded
Triggered when the job finishes successfully.
Top
See Also