Relativity.DataExchange.Process.ProcessContext

ProcessContext

public sealed class ProcessContext

Represents a thread-safe context for a IRunnable process to publish events. This class cannot be inherited.

public object InputArgs { get; set; }

Gets or sets input arguments.

public bool SafeMode { get; set; }

Gets or sets a value indicating whether safe mode is enabled.

public event EventHandler<CancellationRequestEventArgs> CancellationRequest

Occurs when the runnable process has been requested for cancellation.

public event EventHandler<ErrorReportEventArgs> ErrorReport

Occurs when the runnable process non-fatal error is reported.

public event EventHandler<ExportErrorEventArgs> ExportErrorFile

Occurs when the runnable process requests an export error file.

public event EventHandler<ExportErrorEventArgs> ExportErrorReport

Occurs when the runnable process requests an export error report file.

public event EventHandler<ExportErrorEventArgs> ExportServerErrors

Occurs when the runnable process requests the export server errors file.

public event EventHandler<FatalExceptionEventArgs> FatalException

Occurs when the runnable process throws a fatal exception.

public event EventHandler<FieldMappedEventArgs> FieldMapped

Occurs when the runnable process has mapped a source field to a target field.

public event EventHandler<ParentFormClosingEventArgs> ParentFormClosing

Occurs when the runnable process associated with a parent form is closing.

public event EventHandler<ProcessCompleteEventArgs> ProcessCompleted

Occurs when the runnable process has completed.

public event EventHandler<ProcessEndEventArgs> ProcessEnded

Occurs when the runnable process has ended.

public event EventHandler<ProcessEventArgs> ProcessEvent

Occurs when the runnable process event takes place.

public event EventHandler<ProgressEventArgs> Progress

Occurs when the runnable process progress event takes place.

public event EventHandler<RecordCountEventArgs> RecordCountIncremented

Occurs when the runnable process increments the record count.

public event EventHandler<RecordNumberEventArgs> RecordProcessed

Occurs when the runnable process has completed processing a single record.

public event EventHandler<ShowReportEventArgs> ShowReportEvent

Occurs when the runnable process is requested to show the error report.

public event EventHandler<EventArgs> Shutdown

Occurs when the runnable process has shutdown.

public event EventHandler<StatusBarEventArgs> StatusBarChanged

Occurs when a status bar change takes place.

public ProcessContext()

Initializes a new instance of the ProcessContext class.

public ProcessContext(IProcessEventWriter eventWriter, IProcessErrorWriter errorWriter, IAppSettings settings, ILog logger)

Initializes a new instance of the ProcessContext class.

public void Clear()

Clears this instance and assigns null to all events.

public void PublishCancellationRequest(Guid processId)

Halts the runnable process with the specified process unique identifier. This assumes cancellation is requested by the user.

public void PublishCancellationRequest(Guid processId, bool requestByUser)

Halts the runnable process with the specified process unique identifier.

public void PublishErrorEvent(string recordInfo, string message)

Publishes an event indicating the runnable process has handled a non-fatal error.

public void PublishErrorReport(IDictionary error)

Publishes an event indicating the runnable process is reporting a non-fatal error.

public void PublishExportErrorFile(string file)

Publishes an event indicating the runnable process requests an export error file.

public void PublishExportErrorReport(string file)

Publishes an event indicating the runnable process requests an export error report file.

public void PublishExportServerErrors(string file)

Publishes an event indicating the runnable process requests the export server errors file.

public void PublishFatalException(Exception exception)

Publishes an event indicating the runnable process has handled a fatal exception.

public void PublishFieldMapped(string sourceField, string targetField)

Publishes an event indicating the runnable process has mapped a source field to a target field.

public void PublishParentFormClosing(Guid processId)

Publishes an event indicating the runnable process associated with a parent form is closing.

public void PublishProcessCompleted()

Publishes an event indicating the runnable process has completed. By default, closeForm is false, exportFilePath is Empty, and exportLog is false.

public void PublishProcessCompleted(bool closeForm)

Publishes an event indicating the runnable process has completed. By default, exportFilePath is Empty and exportLog is false.

public void PublishProcessCompleted(bool closeForm, string exportFilePath)

Publishes an event indicating the runnable process has completed. By default, exportLog is false.

public void PublishProcessCompleted(bool closeForm, string exportFilePath, bool exportLog)

Publishes an event indicating the runnable process has completed.

public void PublishProcessEnded(long nativeFileBytes, long metadataBytes, double sqlProcessRate)

Publishes an event indicating the runnable process has ended.

public void PublishProgress(long totalRecords, long totalProcessedRecords, long totalProcessedWarningRecords, long totalProcessedErrorRecords, DateTime startTime, DateTime timestamp, double metadataThroughput, double nativeFileThroughput, Guid processId, string totalRecordsDisplay = null, string totalProcessedRecordsDisplay = null, IDictionary metadata = null)

Publishes an event indicating the runnable process progress event has occurred.

public void PublishProgressInBytes(long totalBytes, long processedBytes, DateTime startTime, DateTime timestamp, Guid processId, string totalBytesDisplay, string processedBytesDisplay)

Publishes an event indicating the runnable process progress event has occurred. Progress is measured in number of bytes.

public void PublishRecordCountIncremented()

Publishes an event indicating the runnable process record count has incremented.

public void PublishRecordProcessed(long recordNumber)

Publishes an event indicating the runnable process has completed processing a single record.

public void PublishShutdown()

Publishes an event indicating the runnable process has shutdown.

public void PublishStatusBarChanged(string message, string popupText)

Publishes a status bar change event.

public void PublishStatusEvent(string recordInfo, string message)

Publishes a status event.

public void PublishWarningEvent(string recordInfo, string message)

Publishes a warning event.

public void SaveOutputFile(string file)

Saves the output file to the specified file path.