Show / Hide Table of Contents

Class ForeignKeyTableInfo

Table 'foreignkey': Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables.

Inheritance
Object
TableInfo
ForeignKeyTableInfo
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
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("foreignkey")]
public class ForeignKeyTableInfo : 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 ForeignKey in the database dictionary: foreignkey

Declaration
public const string DictionaryTableName = "foreignkey"
Field Value
Type Description
String

Properties

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 ForeignKey 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

ForeigndeviceId

Field 'foreigndevice_id' in table 'foreignkey': Dictionary type FK, .NET type: Int32

Reference to device definition

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

ForeigndeviceId_InnerJoin_ForeignDevice

Generated join from the foreign key ForeigndeviceId in this table, to its target table ForeignDeviceTableInfo.

Declaration
public TargetedInnerJoin<ForeignDeviceTableInfo> ForeigndeviceId_InnerJoin_ForeignDevice { get; }
Property Value
Type Description
TargetedInnerJoin<ForeignDeviceTableInfo>

ForeignkeyId

Field 'foreignkey_id' in table 'foreignkey': Dictionary type PK, .NET type: Int32

Primary key

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

RecordId

Field 'record_id' in table 'foreignkey': Dictionary type RecordId, .NET type: Int32

Record in the referenced table

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

Registered

Field 'registered' in table 'foreignkey': 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 'foreignkey': Dictionary type FK, .NET type: 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
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable

Seqno

Field 'seqno' in table 'foreignkey': Dictionary type Id, .NET type: Int32

Sequence number, order of subkeys within one key

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

Subkey

Field 'subkey' in table 'foreignkey': Dictionary type String[240], .NET type: String

Subkey (optional)

Declaration
public StringFieldInfo Subkey { get; }
Property Value
Type Description
StringFieldInfo

Subvalue

Field 'subvalue' in table 'foreignkey': Dictionary type String[240], .NET type: String

Key value

Declaration
public StringFieldInfo Subvalue { get; }
Property Value
Type Description
StringFieldInfo

TableId

Field 'table_id' in table 'foreignkey': Dictionary type TableNumber, .NET type: Int16

SuperOffice table reference

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

Updated

Field 'updated' in table 'foreignkey': 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 'foreignkey': Dictionary type FK, .NET type: Int32

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
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

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

Number of updates made to this record

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

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