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.
Implements
Inherited Members
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 TablesInfo.GetHistoryInfo().
Fields
DictionaryTableName
Conceptual name of table History in the database dictionary: History
Declaration
public const string DictionaryTableName = "History"
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 TablesInfo.GetHistoryInfo().
Properties
AssociateId
Field 'associate_id' in table 'History': Dictionary type FK, target: Associate, .NET type: int
Owner of history listDeclaration
public Int32FieldInfo AssociateId { 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 TablesInfo.GetHistoryInfo().
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> |
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.GetHistoryInfo().
Definition
Definition of the table as described in the deployed runtime dictionary
Declaration
public override SoTable Definition { get; }
Property Value
Type | Description |
---|---|
SoTable |
Overrides
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.GetHistoryInfo().
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 |
---|---|
int |
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.GetHistoryInfo().
ExtraId
Field 'extra_id' in table 'History': Dictionary type Id, .NET type: int
Extra ID, used to manage multiple histories per tableDeclaration
public Int32FieldInfo ExtraId { 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 TablesInfo.GetHistoryInfo().
HistoryId
Field 'history_id' in table 'History': Dictionary type PK, .NET type: int
Primary keyDeclaration
public Int32FieldInfo HistoryId { 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 TablesInfo.GetHistoryInfo().
Rank
Field 'rank' in table 'History': Dictionary type UShort, .NET type: short
Sort order, indexed so it can used for sorting in the queryDeclaration
public UInt16FieldInfo Rank { 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 TablesInfo.GetHistoryInfo().
RecordId
Field 'record_id' in table 'History': Dictionary type RecordId, .NET type: int
Record within the tableDeclaration
public Int32FieldInfo RecordId { 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 TablesInfo.GetHistoryInfo().
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 |
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.GetHistoryInfo().
TableId
Field 'table_id' in table 'History': Dictionary type TableNumber, .NET type: short
Table this is a history ofDeclaration
public UInt16FieldInfo TableId { 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 TablesInfo.GetHistoryInfo().
UpdatedCount
Field 'updatedCount' in table 'History': Dictionary type UShort, .NET type: short
Number of updates made to this recordDeclaration
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 TablesInfo.GetHistoryInfo().
Methods
IdxAssociateId(int)
Shortcut method for looking up using the database index AssociateId, which spans the following fields:
Field | Description |
---|---|
AssociateId | Owner of history list |
Declaration
public Restriction IdxAssociateId(int associateId)
Parameters
Type | Name | Description |
---|---|---|
int | associateId |
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 TablesInfo.GetHistoryInfo().
IdxAssociateIdTableId(int, short)
Shortcut method for looking up using the database index AssociateIdTableId, which spans the following fields:
Field | Description |
---|---|
AssociateId | Owner of history list |
TableId | Table this is a history of |
Declaration
public Restriction IdxAssociateIdTableId(int associateId, short tableId)
Parameters
Type | Name | Description |
---|---|---|
int | associateId | |
short | tableId |
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 TablesInfo.GetHistoryInfo().