Class TypicalSearchTableInfo

Table 'TypicalSearch': Owner of a set of predefined selection criteria

Inheritance

Object

TableInfo

TypicalSearchTableInfo

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("TypicalSearch")]
public class TypicalSearchTableInfo : 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 TypicalSearch in the database dictionary: TypicalSearch

Declaration

public const string DictionaryTableName = "TypicalSearch"

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

EntityName

Field 'EntityName' in table 'TypicalSearch': Dictionary type String[256], .NET type: String

The name of the entity the typical search links to

Declaration

public StringFieldInfo EntityName { get; }

Property Value

Type	Description
StringFieldInfo

IncludePerson

Field 'IncludePerson' in table 'TypicalSearch': Dictionary type Bool, .NET type: Int16

For selection-of-company: state of the Include Main Contact checkbox

Declaration

public UInt16FieldInfo IncludePerson { get; }

Property Value

Type	Description
UInt16FieldInfo

IsEntityDefault

Field 'IsEntityDefault' in table 'TypicalSearch': Dictionary type Bool, .NET type: Int16

Indicates if this is the default set of criteria for an entity

Declaration

public UInt16FieldInfo IsEntityDefault { get; }

Property Value

Type	Description
UInt16FieldInfo

Registered

Field 'registered' in table 'TypicalSearch': 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 'TypicalSearch': 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

Source

Field 'Source' in table 'TypicalSearch': Dictionary type String[256], .NET type: String

Name of organisation that sources and maintains this TypicalSearch. Allows for both SuperOffice and partners to maintain sets of typical searches without conflict

Declaration

public StringFieldInfo Source { get; }

Property Value

Type	Description
StringFieldInfo

Title

Field 'Title' in table 'TypicalSearch': Dictionary type String[4001], .NET type: String

The title of the typical search (multilingual)

Declaration

public StringFieldInfo Title { get; }

Property Value

Type	Description
StringFieldInfo

Tooltip

Field 'Tooltip' in table 'TypicalSearch': Dictionary type String[4001], .NET type: String

The tooltip for the typical search (multilingual)

Declaration

public StringFieldInfo Tooltip { get; }

Property Value

Type	Description
StringFieldInfo

TypicalSearchId

Field 'typicalsearch_id' in table 'TypicalSearch': Dictionary type PK, .NET type: Int32

Primary key

Declaration

public Int32FieldInfo TypicalSearchId { get; }

Property Value

Type	Description
Int32FieldInfo

Updated

Field 'updated' in table 'TypicalSearch': 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 'TypicalSearch': 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 'TypicalSearch': Dictionary type UShort, .NET type: Int16

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

VersionNumber

Field 'VersionNumber' in table 'TypicalSearch': Dictionary type Int, .NET type: Int32

The current downloaded version of this typical search

Declaration

public Int32FieldInfo VersionNumber { get; }

Property Value

Type	Description
Int32FieldInfo

Methods

IdxEntityName(String)

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

Field	Description
EntityName	The name of the entity the typical search links to

Declaration

public Restriction IdxEntityName(string entityName)

Parameters

Type	Name	Description
String	entityName

Returns

Type	Description
Restriction

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)