Class BoardViewSettingsTableInfo
Table 'board_view_settings': Settings for selection board view
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("board_view_settings")]
public class BoardViewSettingsTableInfo : 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.GetBoardViewSettingsInfo().
Fields
DictionaryTableName
Conceptual name of table BoardViewSettings in the database dictionary: board_view_settings
Declaration
public const string DictionaryTableName = "board_view_settings"
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.GetBoardViewSettingsInfo().
Properties
AssociateId
Field 'associate_id' in table 'board_view_settings': Dictionary type FK, target: Associate, .NET type: int
The associate this board view settings belongs to (0 for all)Declaration
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.GetBoardViewSettingsInfo().
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.GetBoardViewSettingsInfo().
BoardViewSettingsId
Field 'board_view_settings_id' in table 'board_view_settings': Dictionary type PK, .NET type: int
Primary keyDeclaration
public Int32FieldInfo BoardViewSettingsId { 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.GetBoardViewSettingsInfo().
ColorBy
Field 'color_by' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column name to color onDeclaration
public StringFieldInfo ColorBy { 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 TablesInfo.GetBoardViewSettingsInfo().
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.GetBoardViewSettingsInfo().
DictionaryTableNumber
Table number for table BoardViewSettings 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.GetBoardViewSettingsInfo().
EntityType
Field 'entity_type' in table 'board_view_settings': Dictionary type Enum, .NET type: BoardViewEntityType
The kind of board view entity these settings belong toDeclaration
public BoardViewEntityTypeFieldInfo EntityType { get; }
Property Value
| Type | Description |
|---|---|
| BoardViewEntityTypeFieldInfo |
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.GetBoardViewSettingsInfo().
Filters
Field 'filters' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column names to filter on, comma separatedDeclaration
public StringFieldInfo Filters { 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 TablesInfo.GetBoardViewSettingsInfo().
GroupBy
Field 'group_by' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column name to group onDeclaration
public StringFieldInfo GroupBy { 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 TablesInfo.GetBoardViewSettingsInfo().
HideEmptyGroups
Field 'hide_empty_groups' in table 'board_view_settings': Dictionary type Bool, .NET type: short
Do not show groups with no members/elements if this is trueDeclaration
public UInt16FieldInfo HideEmptyGroups { 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.GetBoardViewSettingsInfo().
Registered
Field 'registered' in table 'board_view_settings': Dictionary type UtcDateTime, .NET type: DateTime
Registered whenDeclaration
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 TablesInfo.GetBoardViewSettingsInfo().
RegisteredAssociateId
Field 'registered_associate_id' in table 'board_view_settings': Dictionary type FK, target: Associate, .NET type: int
Registered by whomDeclaration
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 TablesInfo.GetBoardViewSettingsInfo().
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 TablesInfo.GetBoardViewSettingsInfo().
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.GetBoardViewSettingsInfo().
SelectionId
Field 'selection_id' in table 'board_view_settings': Dictionary type FK, target: Selection, .NET type: int
The selection this board view settings belongs toDeclaration
public Int32FieldInfo SelectionId { 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.GetBoardViewSettingsInfo().
SelectionId_InnerJoin_Selection
Generated join from the foreign key SelectionId in this table, to its target table SelectionTableInfo.
Declaration
public TargetedInnerJoin<SelectionTableInfo> SelectionId_InnerJoin_Selection { get; }
Property Value
| Type | Description |
|---|---|
| TargetedInnerJoin<SelectionTableInfo> |
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.GetBoardViewSettingsInfo().
Settings
Field 'settings' in table 'board_view_settings': Dictionary type Clob, .NET type: string
Settings that are not common to all board views. These are the unique properties of the sub carriers. Stored in json format.Declaration
public StringFieldInfo Settings { 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 TablesInfo.GetBoardViewSettingsInfo().
SortBy
Field 'sort_by' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column name to sort onDeclaration
public StringFieldInfo SortBy { 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 TablesInfo.GetBoardViewSettingsInfo().
SortDesc
Field 'sort_desc' in table 'board_view_settings': Dictionary type Bool, .NET type: short
True if the sort is descendingDeclaration
public UInt16FieldInfo SortDesc { 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.GetBoardViewSettingsInfo().
SubGroupBy
Field 'sub_group_by' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column name to group onDeclaration
public StringFieldInfo SubGroupBy { 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 TablesInfo.GetBoardViewSettingsInfo().
SumBy
Field 'sum_by' in table 'board_view_settings': Dictionary type String[256], .NET type: string
Column name to sum onDeclaration
public StringFieldInfo SumBy { 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 TablesInfo.GetBoardViewSettingsInfo().
Updated
Field 'updated' in table 'board_view_settings': Dictionary type UtcDateTime, .NET type: DateTime
Last updated whenDeclaration
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 TablesInfo.GetBoardViewSettingsInfo().
UpdatedAssociateId
Field 'updated_associate_id' in table 'board_view_settings': Dictionary type FK, target: Associate, .NET type: int
Last updated by whomDeclaration
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 TablesInfo.GetBoardViewSettingsInfo().
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 TablesInfo.GetBoardViewSettingsInfo().
UpdatedCount
Field 'updatedCount' in table 'board_view_settings': 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.GetBoardViewSettingsInfo().
Methods
IdxSelectionId(int)
Shortcut method for looking up using the database index SelectionId, which spans the following fields:
| Field | Description |
|---|---|
| SelectionId | The selection this board view settings belongs to |
Declaration
public Restriction IdxSelectionId(int selectionId)
Parameters
| Type | Name | Description |
|---|---|---|
| int | selectionId |
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.GetBoardViewSettingsInfo().
IdxSelectionIdAssociateId(int, int)
Shortcut method for looking up using the database index SelectionIdAssociateId, which spans the following fields:
| Field | Description |
|---|---|
| SelectionId | The selection this board view settings belongs to |
| AssociateId | The associate this board view settings belongs to (0 for all) |
Declaration
public Restriction IdxSelectionIdAssociateId(int selectionId, int associateId)
Parameters
| Type | Name | Description |
|---|---|---|
| int | selectionId | |
| 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.GetBoardViewSettingsInfo().