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(params FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(string)
TableInfo.ProtAll
TableInfo.UseNolockIfPossible
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.this[string]
TableInfo.PrimaryKeyField
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOfficeCRMData
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 TablesInfo.GetAreaInfo().

Fields

DictionaryTableName

Conceptual name of table Area in the database dictionary: area

Declaration
public const string DictionaryTableName = "area"
Field Value
Type Description
string

Properties

AllData

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

if set to 1, means 'no filtering'

Declaration
public UInt16FieldInfo AllData { get; }
Property Value
Type Description
UInt16FieldInfo

AreaId

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

Primary key

Declaration
public Int32FieldInfo AreaId { get; }
Property Value
Type Description
Int32FieldInfo

DbType

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

0 = as in preferences, 1 = Sybase Anywhere, 2 = Ctree; used when generating prototypes

Declaration
public UInt16FieldInfo DbType { get; }
Property Value
Type Description
UInt16FieldInfo

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

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
int

EncryptedComm

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

Use encryption for this Area?

Declaration
public UInt16FieldInfo EncryptedComm { get; }
Property Value
Type Description
UInt16FieldInfo

FilterType

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

Area filtering algorithm - reserved for future use

Declaration
public UInt16FieldInfo FilterType { get; }
Property Value
Type Description
UInt16FieldInfo

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
TargetedLeftOuterJoinAreaUserAssignmentTableInfo

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
TargetedLeftOuterJoinAreaUserInclusionTableInfo

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
TargetedLeftOuterJoinSatelliteTableInfo

MaxDataAge

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

Max age of data when generating db's based on this area

Declaration
public UInt16FieldInfo MaxDataAge { get; }
Property Value
Type Description
UInt16FieldInfo

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

ParentAreaId

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

Reserved/not implemented: for subareas, travel from satellite, maybe future multi-level satellites

Declaration
public Int32FieldInfo ParentAreaId { get; }
Property Value
Type Description
Int32FieldInfo

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
TargetedInnerJoinAreaTableInfo

Registered

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

Registered when

Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'area': Dictionary type FK, target: Associate, .NET type: int

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
TargetedInnerJoinAssociateTableInfo

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable

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

UpdatedAssociateId

Field 'updated_associate_id' in table 'area': Dictionary type FK, target: Associate, .NET type: int

Last updated by whom

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
TargetedInnerJoinAssociateTableInfo

UpdatedCount

Field 'updatedCount' in table 'area': Dictionary type UShort, .NET type: short

Number of updates made to this record

Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo

Implements

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