Show / Hide Table of Contents

Class PhoneTableInfo

Table 'phone': Contact and Person phonenumbers (+fax)

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

Declaration
public const string DictionaryTableName = "phone"
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

Description

Field 'description' in table 'phone': Dictionary type String[100], .NET type: String

Visible description

Declaration
public StringFieldInfo Description { get; }
Property Value
Type Description
StringFieldInfo

DictionaryTableNumber

Table number for table Phone 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

OwnerId

Field 'owner_id' in table 'phone': Dictionary type Id, .NET type: Int32

Record id of owner: Contact or Person

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

Phone

Field 'phone' in table 'phone': Dictionary type String[240], .NET type: String

Actual phone number as eneterd by the user

Declaration
public StringFieldInfo Phone { get; }
Property Value
Type Description
StringFieldInfo

PhoneId

Field 'phone_id' in table 'phone': Dictionary type PK, .NET type: Int32

Primary key

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

PtypeIdx

Field 'ptype_idx' in table 'phone': Dictionary type Enum, .NET type: PhoneType

Bit mask, combines phone type (EPhoneType) and owner type (EOwnerType)

Declaration
public PhoneTypeFieldInfo PtypeIdx { get; }
Property Value
Type Description
PhoneTypeFieldInfo

Rank

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

Sort order

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

Registered

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

SearchPhoneNumber

Field 'searchPhoneNumber' in table 'phone': Dictionary type String[240], .NET type: String

Stripped phone number for searching, takes over for search_phone

Declaration
public StringFieldInfo SearchPhoneNumber { get; }
Property Value
Type Description
StringFieldInfo

Updated

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

Number of updates made to this record

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

ValidFrom

Field 'validFrom' in table 'phone': Dictionary type DateTime, .NET type: DateTime

Valid from date for this record

Declaration
public DateTimeFieldInfo ValidFrom { get; }
Property Value
Type Description
DateTimeFieldInfo

ValidTo

Field 'validTo' in table 'phone': Dictionary type DateTime, .NET type: DateTime

Valid to date for this record

Declaration
public DateTimeFieldInfo ValidTo { get; }
Property Value
Type Description
DateTimeFieldInfo

Methods

IdxOwnerId(Int32)

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

FieldDescription
OwnerIdRecord id of owner: Contact or Person
Declaration
public Restriction IdxOwnerId(int ownerId)
Parameters
Type Name Description
Int32 ownerId
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