Show / Hide Table of Contents

Class AreaTableInfo

Table 'area': Definition of an Area (database subset for satellite and travel)

Inheritance
Object
TableInfo
AreaTableInfo
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("area")]
public class AreaTableInfo : 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 Area in the database dictionary: area

Declaration
public const string DictionaryTableName = "area"
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

AllData

Field 'allData' in table 'area': Dictionary type UShort, .NET type: Int16

if set to 1, means 'no filtering'
Declaration
public UInt16FieldInfo AllData { 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 .

AreaId

Field 'area_id' in table 'area': Dictionary type PK, .NET type: Int32

Primary key
Declaration
public Int32FieldInfo AreaId { 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 .

DbType

Field 'dbType' in table 'area': Dictionary type UShort, .NET type: Int16

0 = as in preferences, 1 = Sybase Anywhere, 2 = Ctree; used when generating prototypes
Declaration
public UInt16FieldInfo DbType { 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 .

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 .

DictionaryTableNumber

Table number for table Area 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 .

EncryptedComm

Field 'encryptedComm' in table 'area': Dictionary type UShort, .NET type: Int16

Use encryption for this Area?
Declaration
public UInt16FieldInfo EncryptedComm { 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 .

FilterType

Field 'filterType' in table 'area': Dictionary type UShort, .NET type: Int16

Area filtering algorithm - reserved for future use
Declaration
public UInt16FieldInfo FilterType { 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_AreaUserAssignment_AreaId

Generated left outer join from the primary key AreaId on this table, to AreaUserAssignment.AreaId.

Declaration
public TargetedLeftOuterJoin<AreaUserAssignmentTableInfo> LeftOuterJoin_AreaUserAssignment_AreaId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<AreaUserAssignmentTableInfo>
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_AreaUserInclusion_AreaId

Generated left outer join from the primary key AreaId on this table, to AreaUserInclusion.AreaId.

Declaration
public TargetedLeftOuterJoin<AreaUserInclusionTableInfo> LeftOuterJoin_AreaUserInclusion_AreaId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<AreaUserInclusionTableInfo>
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_Satellite_AreaId

Generated left outer join from the primary key AreaId on this table, to Satellite.AreaId.

Declaration
public TargetedLeftOuterJoin<SatelliteTableInfo> LeftOuterJoin_Satellite_AreaId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SatelliteTableInfo>
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 .

MaxDataAge

Field 'maxDataAge' in table 'area': Dictionary type UShort, .NET type: Int16

Max age of data when generating db's based on this area
Declaration
public UInt16FieldInfo MaxDataAge { 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 .

Name

Field 'name' in table 'area': Dictionary type String[50], .NET type: String

Area name
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 .

ParentAreaId

Field 'parent_area_id' in table 'area': Dictionary type FK, target: Area, .NET type: Int32

Reserved/not implemented: for subareas, travel from satellite, maybe future multi-level satellites
Declaration
public Int32FieldInfo ParentAreaId { 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 .

ParentAreaId_InnerJoin_Area

Generated join from the foreign key ParentAreaId in this table, to its target table AreaTableInfo.

Declaration
public TargetedInnerJoin<AreaTableInfo> ParentAreaId_InnerJoin_Area { get; }
Property Value
Type Description
TargetedInnerJoin<AreaTableInfo>
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 'area': 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 'area': 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 .

Updated

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

Last updated when
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 'area': Dictionary type FK, target: Associate, .NET type: Int32

Last updated by whom
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 'area': Dictionary type UShort, .NET type: Int16

Number of updates made to this record
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 .

Implements

System.ICloneable

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