Show / Hide Table of Contents

Class HistoryTableInfo

Table 'History': History lists for lists and searchable controls. Maintains history for Navigator or other search (find dialogs). A single table may have more than one record here, as indicated by the extra_id field. The HistorySize (preference may be set in maintenance client) defines how many records you can have in a history list.

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

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

Properties

AssociateId

Field 'associate_id' in table 'History': Dictionary type FK, .NET type: Int32

Owner of history list

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

AssociateId_InnerJoin_Associate

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

Declaration
public TargetedInnerJoin<AssociateTableInfo> AssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

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

ExtraId

Field 'extra_id' in table 'History': Dictionary type Id, .NET type: Int32

Extra ID, used to manage multiple histories per table

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

HistoryId

Field 'history_id' in table 'History': Dictionary type PK, .NET type: Int32

Primary key

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

Rank

Field 'rank' in table 'History': Dictionary type UShort, .NET type: Int16

Sort order, indexed so it can used for sorting in the query

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

RecordId

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

Record within the table

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

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

TableId

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

Table this is a history of

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

UpdatedCount

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

Number of updates made to this record

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

Methods

IdxAssociateId(Int32)

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

FieldDescription
AssociateIdOwner of history list
Declaration
public Restriction IdxAssociateId(int associateId)
Parameters
Type Name Description
Int32 associateId
Returns
Type Description
Restriction

IdxAssociateIdTableId(Int32, Int16)

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

FieldDescription
AssociateIdOwner of history list
TableIdTable this is a history of
Declaration
public Restriction IdxAssociateIdTableId(int associateId, short tableId)
Parameters
Type Name Description
Int32 associateId
Int16 tableId
Returns
Type Description
Restriction

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