Class BatchTaskInfo

BatchTaskInfo contains information about one batch task.

Carrier object for BatchTaskInfo. Services for the BatchTaskInfo Carrier is available from the Batch Agent.
Inheritance
object
BatchTaskInfo
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/10.3.0.0")]
public class BatchTaskInfo : Carrier

Constructors

BatchTaskInfo()

Default constructor

Declaration
public BatchTaskInfo()
See Also

Properties

AssociateId

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

Declaration
[DataMember]
public virtual int AssociateId { get; set; }
Property Value
Type Description
int
See Also

CancellationBehaviour

Indicate if the task can be stopped.

Declaration
[DataMember]
public virtual BatchTaskCancellationBehaviour CancellationBehaviour { get; set; }
Property Value
Type Description
BatchTaskCancellationBehaviour
See Also

Context

Context for the executing task.

Declaration
[DataMember]
public virtual string Context { get; set; }
Property Value
Type Description
string
See Also

Created

Task creation time.

Declaration
[DataMember]
public virtual DateTime Created { get; set; }
Property Value
Type Description
DateTime
See Also

DatabaseSerialNumber

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

Declaration
[DataMember]
public virtual string DatabaseSerialNumber { get; set; }
Property Value
Type Description
string
See Also

Description

Description of the task.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

DetailsRecord

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

Declaration
[DataMember]
public virtual int DetailsRecord { get; set; }
Property Value
Type Description
int
See Also

DetailsTable

Id of table with more information about the task.

Declaration
[DataMember]
public virtual short DetailsTable { get; set; }
Property Value
Type Description
short
See Also

FileName

The filename related to the batchtask.

Declaration
[DataMember]
public virtual string FileName { get; set; }
Property Value
Type Description
string
See Also

Id

Id of the task.

Declaration
[DataMember]
public virtual int Id { get; set; }
Property Value
Type Description
int
See Also

IsInternalTask

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

Declaration
[DataMember]
public virtual bool IsInternalTask { get; set; }
Property Value
Type Description
bool
See Also

IsSystemTask

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

Declaration
[DataMember]
public virtual bool IsSystemTask { get; set; }
Property Value
Type Description
bool
See Also

LastStarted

When was the task last started.

Declaration
[DataMember]
public virtual DateTime LastStarted { get; set; }
Property Value
Type Description
DateTime
See Also

Name

Name of the task.

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

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.

Declaration
[DataMember]
public virtual StringDictionary ParameterObject { get; set; }
Property Value
Type Description
StringDictionary
See Also

ProgressDescription

Descriptive text for the current stage

Declaration
[DataMember]
public virtual string ProgressDescription { get; set; }
Property Value
Type Description
string
See Also

ProgressPercent

Task progress, in percent of estimated total

Declaration
[DataMember]
public virtual short ProgressPercent { get; set; }
Property Value
Type Description
short
See Also

Request

Maps to the request field in the batchtask table.

Declaration
[DataMember]
public virtual string Request { get; set; }
Property Value
Type Description
string
See Also

Response

Maps to the response field in the batchtask table.

Declaration
[DataMember]
public virtual string Response { get; set; }
Property Value
Type Description
string
See Also

Result

Maps to the result field in the batchtask table.

Declaration
[DataMember]
public virtual string Result { get; set; }
Property Value
Type Description
string
See Also

StartCount

Maps to the startcount field in the batchtask table.

Declaration
[DataMember]
public virtual int StartCount { get; set; }
Property Value
Type Description
int
See Also

State

BatchTaskState of the task.

Declaration
[DataMember]
public virtual BatchTaskState State { get; set; }
Property Value
Type Description
BatchTaskState
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also