Show / Hide Table of Contents

Class SearchCriteriaTableInfo

Table 'SearchCriteria': Criteria storage for Selection and other Find mechanisms

Inheritance
object
TableInfo
SearchCriteriaTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(params FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(string)
TableInfo.ProtAll
TableInfo.UseNolockIfPossible
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.this[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("SearchCriteria")]
public class SearchCriteriaTableInfo : 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.GetSearchCriteriaInfo().

Fields

DictionaryTableName

Conceptual name of table SearchCriteria in the database dictionary: SearchCriteria

Declaration
public const string DictionaryTableName = "SearchCriteria"
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.GetSearchCriteriaInfo().

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
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.GetSearchCriteriaInfo().

DictionaryTableNumber

Table number for table SearchCriteria 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.GetSearchCriteriaInfo().

DisplayName

Field 'displayName' in table 'SearchCriteria': Dictionary type String[255], .NET type: string

Display name when these criteria are a saved archive filter
Declaration
public StringFieldInfo DisplayName { 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.GetSearchCriteriaInfo().

LeftOuterJoin_SearchCriteriaGroup_SearchCriteriaId

Generated left outer join from the primary key SearchCriteriaId on this table, to SearchCriteriaGroup.SearchCriteriaId.

Declaration
public TargetedLeftOuterJoin<SearchCriteriaGroupTableInfo> LeftOuterJoin_SearchCriteriaGroup_SearchCriteriaId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SearchCriteriaGroupTableInfo>
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.GetSearchCriteriaInfo().

Name

Field 'name' in table 'SearchCriteria': Dictionary type String[255], .NET type: string

Name of this criteria collection
Declaration
public StringFieldInfo Name { 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.GetSearchCriteriaInfo().

OwnerGuiName

Field 'ownerGuiName' in table 'SearchCriteria': Dictionary type String[255], .NET type: string

Name of the owner GUI control, this is the GUI XML id in SIX.web
Declaration
public StringFieldInfo OwnerGuiName { 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.GetSearchCriteriaInfo().

OwnerId

Field 'ownerId' in table 'SearchCriteria': Dictionary type RecordId, .NET type: int

Record ID in ownerTable that owns these criteria
Declaration
public Int32FieldInfo OwnerId { 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.GetSearchCriteriaInfo().

OwnerName

Field 'ownerName' in table 'SearchCriteria': Dictionary type String[255], .NET type: string

Name of owner; this is the archive provider name in NetServer/SIX.web
Declaration
public StringFieldInfo OwnerName { 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.GetSearchCriteriaInfo().

OwnerTable

Field 'ownerTable' in table 'SearchCriteria': Dictionary type TableNumber, .NET type: short

Table number of table that owns these criteria
Declaration
public UInt16FieldInfo OwnerTable { 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.GetSearchCriteriaInfo().

OwnerType

Field 'ownerType' in table 'SearchCriteria': Dictionary type Enum, .NET type: short

Selection, Reporter, FindProject, ...
Declaration
public FieldInfo OwnerType { get; }
Property Value
Type Description
FieldInfo
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.GetSearchCriteriaInfo().

Registered

Field 'registered' in table 'SearchCriteria': Dictionary type UtcDateTime, .NET type: DateTime

Registered when
Declaration
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.GetSearchCriteriaInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'SearchCriteria': Dictionary type FK, target: Associate, .NET type: int

Registered by whom
Declaration
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.GetSearchCriteriaInfo().

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.GetSearchCriteriaInfo().

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.GetSearchCriteriaInfo().

SearchCriteriaId

Field 'SearchCriteria_id' in table 'SearchCriteria': Dictionary type PK, .NET type: int

Primary key
Declaration
public Int32FieldInfo SearchCriteriaId { 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.GetSearchCriteriaInfo().

TextId

Field 'textId' in table 'SearchCriteria': Dictionary type FK, target: Text, .NET type: int

Extra information (descriptive) for this Criteria set
Declaration
public Int32FieldInfo TextId { 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.GetSearchCriteriaInfo().

TextId_InnerJoin_Text

Generated join from the foreign key TextId in this table, to its target table TextTableInfo.

Declaration
public TargetedInnerJoin<TextTableInfo> TextId_InnerJoin_Text { get; }
Property Value
Type Description
TargetedInnerJoin<TextTableInfo>
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.GetSearchCriteriaInfo().

Updated

Field 'updated' in table 'SearchCriteria': Dictionary type UtcDateTime, .NET type: DateTime

Last updated when
Declaration
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.GetSearchCriteriaInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'SearchCriteria': Dictionary type FK, target: Associate, .NET type: int

Last updated by whom
Declaration
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.GetSearchCriteriaInfo().

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.GetSearchCriteriaInfo().

UpdatedCount

Field 'updatedCount' in table 'SearchCriteria': Dictionary type UShort, .NET type: short

Number of updates made to this record
Declaration
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.GetSearchCriteriaInfo().

Methods

IdxOwnerId(int)

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

FieldDescription
OwnerIdRecord ID in ownerTable that owns these criteria
Declaration
public Restriction IdxOwnerId(int ownerId)
Parameters
Type Name Description
int ownerId
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.GetSearchCriteriaInfo().

IdxOwnerIdOwnerName(int, string)

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

FieldDescription
OwnerIdRecord ID in ownerTable that owns these criteria
OwnerNameName of owner; this is the archive provider name in NetServer/SIX.web
Declaration
public Restriction IdxOwnerIdOwnerName(int ownerId, string ownerName)
Parameters
Type Name Description
int ownerId
string ownerName
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.GetSearchCriteriaInfo().

IdxOwnerIdOwnerTable(int, short)

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

FieldDescription
OwnerIdRecord ID in ownerTable that owns these criteria
OwnerTableTable number of table that owns these criteria
Declaration
public Restriction IdxOwnerIdOwnerTable(int ownerId, short ownerTable)
Parameters
Type Name Description
int ownerId
short ownerTable
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.GetSearchCriteriaInfo().

IdxOwnerIdOwnerTableOwnerType(int, short, short)

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

FieldDescription
OwnerIdRecord ID in ownerTable that owns these criteria
OwnerTableTable number of table that owns these criteria
OwnerTypeSelection, Reporter, FindProject, ...
Declaration
public Restriction IdxOwnerIdOwnerTableOwnerType(int ownerId, short ownerTable, short ownerType)
Parameters
Type Name Description
int ownerId
short ownerTable
short ownerType
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.GetSearchCriteriaInfo().

Implements

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