Show / Hide Table of Contents

Class BatchTaskAttribute

BatchTaskAttribute defines attributes for a batch task plugin.

Inheritance
object
BatchTaskAttribute
Namespace: SuperOffice.CRM.BatchProcessing
Assembly: SoBatchProcessing.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public class BatchTaskAttribute : PluginAttribute

Constructors

BatchTaskAttribute(string)

Default constructor using all default values.

Declaration
public BatchTaskAttribute(string name)
Parameters
Type Name Description
string name

BatchTaskAttribute(string, BatchTaskCancellationBehaviour)

Constructor to specify cancellation behaviour

Declaration
public BatchTaskAttribute(string name, BatchTaskCancellationBehaviour cancellationBehaviour)
Parameters
Type Name Description
string name
BatchTaskCancellationBehaviour cancellationBehaviour

Properties

CancellationBehaviour

Cancellation behaviour - indicates if the batch task is cancellable

Declaration
public BatchTaskCancellationBehaviour CancellationBehaviour { get; set; }
Property Value
Type Description
BatchTaskCancellationBehaviour

DefaultCancellationBehaviour

Default cancellation behaviour

Declaration
public static BatchTaskCancellationBehaviour DefaultCancellationBehaviour { get; }
Property Value
Type Description
BatchTaskCancellationBehaviour

Description

Gets or sets Description

Declaration
public string Description { get; set; }
Property Value
Type Description
string

ManualCleanup

Should cleanup of batchtask-related data in db be deferred?

Declaration
public bool ManualCleanup { get; set; }
Property Value
Type Description
bool

Timeout

Gets or sets Timeout

Declaration
public int Timeout { get; set; }
Property Value
Type Description
int

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top