Class BatchTaskDefinitionTableInfo

Table 'BatchTaskDefinition': Batch task definitiopns, populated from the SuperOffice.CRM.BatchProcessing.BatchTask attribute

Inheritance

System.Object

TableInfo

BatchTaskDefinitionTableInfo

Implements

System.ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(String)

TableInfo.ProtAll

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.Item[String]

TableInfo.PrimaryKeyField

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("BatchTaskDefinition")]
public class BatchTaskDefinitionTableInfo : TableInfo, ICloneable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table BatchTaskDefinition in the database dictionary: BatchTaskDefinition

Declaration

public const string DictionaryTableName = "BatchTaskDefinition"

Field Value

Type	Description
System.String

Properties

AssemblyVersion

Field 'assemblyVersion' in table 'BatchTaskDefinition': Dictionary type String[50], .NET type: System.String

Version of the assembly that contains the code this batch task definition was populated from

Declaration

public StringFieldInfo AssemblyVersion { get; }

Property Value

Type	Description
StringFieldInfo

AutoRestartCount

Field 'autoRestartCount' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: System.Int32

Number of times the whole batch task should be restarted; -1 means infinite, which is useful for things like Travel Gateway that should 'always' be available

Declaration

public Int32FieldInfo AutoRestartCount { get; }

Property Value

Type	Description
Int32FieldInfo

BatchTaskDefinitionId

Field 'BatchTaskDefinition_id' in table 'BatchTaskDefinition': Dictionary type PK, .NET type: System.Int32

Primary key

Declaration

public Int32FieldInfo BatchTaskDefinitionId { get; }

Property Value

Type	Description
Int32FieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration

public override SoTable Definition { get; }

Property Value

Type	Description
SoTable

Overrides

TableInfo.Definition

Description

Field 'description' in table 'BatchTaskDefinition': Dictionary type String[255], .NET type: System.String

Description of task (for monitoring and debugging)

Declaration

public StringFieldInfo Description { get; }

Property Value

Type	Description
StringFieldInfo

DictionaryTableNumber

Table number for table BatchTaskDefinition in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration

public int DictionaryTableNumber { get; }

Property Value

Type	Description
System.Int32

IsMultiPass

Field 'isMultiPass' in table 'BatchTaskDefinition': Dictionary type Bool, .NET type: System.Int16

Is this a multipass job (inner implementationis run repeatedly by the batch task framework)

Declaration

public UInt16FieldInfo IsMultiPass { get; }

Property Value

Type	Description
UInt16FieldInfo

LeftOuterJoin_BatchTask_BatchTaskDefinitionId

Generated left outer join from the primary key BatchTaskDefinitionId on this table, to BatchTask.BatchTaskDefinitionId.

Declaration

public TargetedLeftOuterJoin<BatchTaskTableInfo> LeftOuterJoin_BatchTask_BatchTaskDefinitionId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<BatchTaskTableInfo>

MinimumSleepTime

Field 'minimumSleepTime' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: System.Int32

Minimum sleep interval between the end of one run and start of the next one

Declaration

public Int32FieldInfo MinimumSleepTime { get; }

Property Value

Type	Description
Int32FieldInfo

Name

Field 'name' in table 'BatchTaskDefinition': Dictionary type String[255], .NET type: System.String

Name of task (for monitoring and debugging)

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

Registered

Field 'registered' in table 'BatchTaskDefinition': Dictionary type UtcDateTime, .NET type: System.DateTime

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'BatchTaskDefinition': Dictionary type FK, target: Associate, .NET type: System.Int32

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

StartInterval

Field 'startInterval' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: System.Int32

Minimum interval between successive starts; starts never overlap

Declaration

public Int32FieldInfo StartInterval { get; }

Property Value

Type	Description
Int32FieldInfo

Timeout

Field 'timeout' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: System.Int32

Maximum allowed execution time; jobs are killed if they exceed their timeout; 0=no timeout

Declaration

public Int32FieldInfo Timeout { get; }

Property Value

Type	Description
Int32FieldInfo

Updated

Field 'updated' in table 'BatchTaskDefinition': Dictionary type UtcDateTime, .NET type: System.DateTime

'heartbeat' that is updated once a minute by the batch task process

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'BatchTaskDefinition': Dictionary type FK, target: Associate, .NET type: System.Int32

'heartbeat' that is updated once a minute by the batch task process

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'BatchTaskDefinition': Dictionary type UShort, .NET type: System.Int16

heartbeat' that is updated once a minute by the batch task process

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

Methods

IdxName(String)

Shortcut method for looking up using the database index Name, which spans the following fields:

Field	Description
Name	Name of task (for monitoring and debugging)

Declaration

public Restriction IdxName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
Restriction

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)