Class BinaryObjectTableInfo

Table 'BinaryObject': Binary objects, i.e., blobs. Used for images, documents, SuperOffice inbox mail and other large binary items

Inheritance
object
TableInfo
BinaryObjectTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("BinaryObject")]
public class BinaryObjectTableInfo : 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.GetBinaryObjectInfo().

Fields

DictionaryTableName

Conceptual name of table BinaryObject in the database dictionary: BinaryObject

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

Properties

BinaryData

Field 'binaryData' in table 'BinaryObject': Dictionary type Blob, .NET type: Stream

The binary data itself. Length is limited by the database, generally 1GB seems to be reliably available. Beyond that is database dependent.
Declaration
public FieldInfo BinaryData { 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.GetBinaryObjectInfo().

BinaryObjectId

Field 'BinaryObject_id' in table 'BinaryObject': Dictionary type PK, .NET type: int

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

BlobSize

Field 'blobSize' in table 'BinaryObject': Dictionary type UInt, .NET type: uint

The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself!
Declaration
public FieldInfo BlobSize { 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.GetBinaryObjectInfo().

ConceptualType

Field 'conceptualType' in table 'BinaryObject': Dictionary type String[255], .NET type: string

The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is
Declaration
public StringFieldInfo ConceptualType { 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.GetBinaryObjectInfo().

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

Description

Field 'description' in table 'BinaryObject': Dictionary type String[255], .NET type: string

A description that is entered by the user, and visible to the user
Declaration
public StringFieldInfo Description { 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.GetBinaryObjectInfo().

DictionaryTableNumber

Table number for table BinaryObject 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.GetBinaryObjectInfo().

ExtraInfo

Field 'extraInfo' in table 'BinaryObject': Dictionary type String[255], .NET type: string

Extra information, spare field, can be used for anything that makes sense. Should not refer to any particular context, that is something for the BinaryObjectLInk
Declaration
public StringFieldInfo ExtraInfo { 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.GetBinaryObjectInfo().

IsEncrypted

Field 'isEncrypted' in table 'BinaryObject': Dictionary type Bool, .NET type: short

Has the data been encrypted (support for this will come in HDB)
Declaration
public UInt16FieldInfo IsEncrypted { 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.GetBinaryObjectInfo().

IsZipped

Field 'isZipped' in table 'BinaryObject': Dictionary type Bool, .NET type: short

Has the data been zipped (support for this will come in HDB)
Declaration
public UInt16FieldInfo IsZipped { 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.GetBinaryObjectInfo().

Generated left outer join from the primary key BinaryObjectId on this table, to BinaryObjectLink.BinaryObjectId.

Declaration
public TargetedLeftOuterJoin<BinaryObjectLinkTableInfo> LeftOuterJoin_BinaryObjectLink_BinaryObjectId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<BinaryObjectLinkTableInfo>

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

LeftOuterJoin_ExtraTables_IconId

Generated left outer join from the primary key BinaryObjectId on this table, to ExtraTables.IconId.

Declaration
public TargetedLeftOuterJoin<ExtraTablesTableInfo> LeftOuterJoin_ExtraTables_IconId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ExtraTablesTableInfo>
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.GetBinaryObjectInfo().

MimeType

Field 'mimeType' in table 'BinaryObject': Dictionary type String[255], .NET type: string

Mime type, describing the technical type (image/jpeg) of the data
Declaration
public StringFieldInfo MimeType { 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.GetBinaryObjectInfo().

OriginalSize

Field 'originalSize' in table 'BinaryObject': Dictionary type UInt, .NET type: uint

Original size of the binary data, before encryption and/or zipping. This is what the ultimate client will get
Declaration
public FieldInfo OriginalSize { 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.GetBinaryObjectInfo().

Registered

Field 'registered' in table 'BinaryObject': 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.GetBinaryObjectInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'BinaryObject': 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.GetBinaryObjectInfo().

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

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

Updated

Field 'updated' in table 'BinaryObject': 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.GetBinaryObjectInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'BinaryObject': 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.GetBinaryObjectInfo().

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

UpdatedCount

Field 'updatedCount' in table 'BinaryObject': 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.GetBinaryObjectInfo().

Implements

Extension Methods