Class BatchTaskDefinitionTableInfo

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

Inheritance

Object

TableInfo

BatchTaskDefinitionTableInfo

Implements

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
String

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 .

Properties

AssemblyVersion

Field 'assemblyVersion' in table 'BatchTaskDefinition': Dictionary type String[50], .NET type: 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

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 .

AutoRestartCount

Field 'autoRestartCount' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: 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

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 .

BatchTaskDefinitionId

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

Primary key

Declaration

public Int32FieldInfo BatchTaskDefinitionId { get; }

Property Value

Type	Description
Int32FieldInfo

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 .

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

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 .

Description

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

Description of task (for monitoring and debugging)

Declaration

public StringFieldInfo Description { get; }

Property Value

Type	Description
StringFieldInfo

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 .

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
Int32

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 .

IsMultiPass

Field 'isMultiPass' in table 'BatchTaskDefinition': Dictionary type Bool, .NET type: 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

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 .

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>

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 .

MinimumSleepTime

Field 'minimumSleepTime' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: 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

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 .

Name

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

Name of task (for monitoring and debugging)

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

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 .

Registered

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

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

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 .

RegisteredAssociateId

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

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

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 .

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>

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 .

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

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 .

StartInterval

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

Minimum interval between successive starts; starts never overlap

Declaration

public Int32FieldInfo StartInterval { get; }

Property Value

Type	Description
Int32FieldInfo

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 .

Timeout

Field 'timeout' in table 'BatchTaskDefinition': Dictionary type Int, .NET type: 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

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 .

Updated

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

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

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

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 .

UpdatedAssociateId

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

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

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

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 .

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>

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 .

UpdatedCount

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

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

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

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 .

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
String	name

Returns

Type	Description
Restriction

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 .

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)