Skip to main content

Class BatchTaskInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for BatchTaskInfo. BatchTaskInfo contains information about one batch task.

Inheritance

objectCarrierBatchTaskInfo

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

BatchTaskInfo()

Default constructor - defaults any enum props to 0.

Properties

AssociateId

Task owner. If it is a System task, AssociateId = 0.

Property Value

int

CancellationBehaviour

Indicate if the task can be stopped. NULL if unknown enum value.

Property Value

BatchTaskCancellationBehaviour?

See Also

BatchTaskInfo.CancellationBehaviour_String

CancellationBehaviour_String

Indicate if the task can be stopped. Raw string enum value.

Property Value

string

See Also

BatchTaskInfo.CancellationBehaviour

Context

Context for the executing task.

Property Value

string

Created

Task creation time.

Property Value

DateTime

DatabaseSerialNumber

Serial number of the database the task is to run on.

Property Value

string

Description

Description of the task.

Property Value

string

DetailsRecord

Record Id of a row in the DetailsTable containing more info about the task.

Property Value

int

DetailsTable

Id of table with more information about the task.

Property Value

short

FileName

The filename related to the batchtask.

Property Value

string

Id

Id of the task.

Property Value

int

IsInternalTask

If IsInternalTask is true, this task will not add a trace to the database.

Property Value

bool

IsSystemTask

If IsSystemTask is true, the task is not initiated by an associate.

Property Value

bool

LastStarted

When was the task last started.

Property Value

DateTime

Name

Name of the task.

Property Value

string

ParameterObject

ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

Property Value

StringDictionary

ProgressDescription

Descriptive text for the current stage

Property Value

string

ProgressPercent

Task progress, in percent of estimated total

Property Value

short

Request

Maps to the request field in the batchtask table.

Property Value

string

Response

Maps to the response field in the batchtask table.

Property Value

string

Result

Maps to the result field in the batchtask table.

Property Value

string

StartCount

Maps to the startcount field in the batchtask table.

Property Value

int

State

BatchTaskState of the task. NULL if unknown enum value.

Property Value

BatchTaskState?

See Also

BatchTaskInfo.State_String

State_String

BatchTaskState of the task. Raw string enum value.

Property Value

string

See Also

BatchTaskInfo.State

See Also

BatchAgent