Class ProductTableInfo

Table 'Product': One Product, member of one price list

Inheritance
Object
TableInfo
ProductTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("Product")]
public class ProductTableInfo : 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 Product in the database dictionary: Product

Declaration
public const string DictionaryTableName = "Product"
Field Value
Type Description
String

Properties

Code

Field 'Code' in table 'Product': Dictionary type String[255], .NET type: String

The product code / article number in the product supplier system.

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

DefaultSubscriptionQuantity

Field 'DefaultSubscriptionQuantity' in table 'Product': Dictionary type Double, .NET type: Double

The default number of SubscriptionUnits to suggest when creating quote lines from this product

Declaration
public DoubleFieldInfo DefaultSubscriptionQuantity { get; }
Property Value
Type Description
DoubleFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides

Description

Field 'Description' in table 'Product': Dictionary type String[2048], .NET type: String

The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too.

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

DictionaryTableNumber

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

ERPProductKey

Field 'ERPProductKey' in table 'Product': Dictionary type String[255], .NET type: String

Reference/foreign key to the product in the given pricelist in the product supplier system, if it exists there.

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

ExtraField1

Field 'extraField1' in table 'Product': Dictionary type String[1024], .NET type: String

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

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

ExtraField2

Field 'extraField2' in table 'Product': Dictionary type String[1024], .NET type: String

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

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

ExtraField3

Field 'extraField3' in table 'Product': Dictionary type String[1024], .NET type: String

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

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

ExtraField4

Field 'extraField4' in table 'Product': Dictionary type String[1024], .NET type: String

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

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

ExtraField5

Field 'extraField5' in table 'Product': Dictionary type String[1024], .NET type: String

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

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

ExtraInfo

Field 'ExtraInfo' in table 'Product': Dictionary type Clob, .NET type: String

Extra data (fields with labels). Shall be shown in the quoteline dialog. Additional info that the ERP system would like to store and show in the user interface. Information placed here is shown in the GUI if the “provide-extra-data” capability is true. Different products can have different fields. It will not be possible to directly put info here into the quote document.

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

InAssortment

Field 'InAssortment' in table 'Product': Dictionary type Bool, .NET type: Int16

True for products that should currently be offered, false when the product is discontinued and should not ordinarily be offered. When false the product no longer appears in search results.

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

IsSubscription

Field 'IsSubscription' in table 'Product': Dictionary type Bool, .NET type: Int16

Is this a subscription product, sold in repeating intervals/amounts?

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

ItemNumber

Field 'ItemNumber' in table 'Product': Dictionary type String[80], .NET type: String

Line item number, NOR: «Postnummer». Specific numbers from some hierarchy, for instance “1.4.3.2P”. Typically used to sort the items in the quote by some standard way.

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

Name

Field 'Name' in table 'Product': Dictionary type String[255], .NET type: String

The name to use in the user interface.

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

PriceListId

Field 'PriceListId' in table 'Product': Dictionary type FK, .NET type: Int32

Foreign key to the price list that this product is a part of.

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

PriceListId_InnerJoin_PriceList

Generated join from the foreign key PriceListId in this table, to its target table PriceListTableInfo.

Declaration
public TargetedInnerJoin<PriceListTableInfo> PriceListId_InnerJoin_PriceList { get; }
Property Value
Type Description
TargetedInnerJoin<PriceListTableInfo>

PriceUnit

Field 'PriceUnit' in table 'Product': Dictionary type String[80], .NET type: String

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products

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

ProductCategoryKey

Field 'ProductCategoryKey' in table 'Product': Dictionary type String[255], .NET type: String

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product category.

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

ProductFamilyKey

Field 'ProductFamilyKey' in table 'Product': Dictionary type String[255], .NET type: String

Either a List id to an id from a connector provided list, or, if the connection doesn't support lists, a text with the actual product family.

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

ProductId

Field 'product_id' in table 'Product': Dictionary type PK, .NET type: Int32

Primary key

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

ProductTypeKey

Field 'ProductTypeKey' in table 'Product': Dictionary type String[255], .NET type: String

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product type.

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

QuantityUnit

Field 'QuantityUnit' in table 'Product': Dictionary type String[80], .NET type: String

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different

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

Registered

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

Rights

Field 'Rights' in table 'Product': Dictionary type String[2048], .NET type: String

Field1=right&Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of: N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quoteline, like Image will also be possibly to set rights on. Will be used by SuperOffice to control the user interface when showing the record.

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

Rule

Field 'Rule' in table 'Product': Dictionary type String[255], .NET type: String

The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive. Will NOT be used by SuperOffice.

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

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

SubscriptionUnit

Field 'SubscriptionUnit' in table 'Product': Dictionary type String[255], .NET type: String

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual subscription unit.

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

Supplier

Field 'Supplier' in table 'Product': Dictionary type String[255], .NET type: String

In SuperOffice, an id from the contact table, when saved as an ERP cache, the name of the supplier

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

SupplierCode

Field 'SupplierCode' in table 'Product': Dictionary type String[255], .NET type: String

Suppliers part code/number or other key-like field

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

UnitCost

Field 'UnitCost' in table 'Product': Dictionary type Double, .NET type: Double

The cost price. Might not be given, use Decimal.MinValue to signal this.

Declaration
public DoubleFieldInfo UnitCost { get; }
Property Value
Type Description
DoubleFieldInfo

UnitListPrice

Field 'UnitListPrice' in table 'Product': Dictionary type Double, .NET type: Double

(Basic Price, normal price, standard price.) This is the basic price from which the discount is computed from. The ListPrice will stay the same even when a larger amount is ordered.

Declaration
public DoubleFieldInfo UnitListPrice { get; }
Property Value
Type Description
DoubleFieldInfo

UnitMinimumPrice

Field 'UnitMinimumPrice' in table 'Product': Dictionary type Double, .NET type: Double

The minimum price this salesman can offer to his customer. This might be cost price if there is no policy. Might not be given, use Decimal.MinValue to signal this.

Declaration
public DoubleFieldInfo UnitMinimumPrice { get; }
Property Value
Type Description
DoubleFieldInfo

Updated

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

Number of updates made to this record

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

Url

Field 'Url' in table 'Product': Dictionary type String[1024], .NET type: String

URL to product information web page.

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

VAT

Field 'VAT' in table 'Product': Dictionary type Double, .NET type: Double

Tax/VAT if available from ERP system. THIS IS A PERCENTAGE. In the Superoffice product register, this field is available in the product admin GUI.

Declaration
public DoubleFieldInfo VAT { get; }
Property Value
Type Description
DoubleFieldInfo

VATInfo

Field 'VATInfo' in table 'Product': Dictionary type String[255], .NET type: String

A field for putting VATInfo you need to show in the final quoteDocument, like the VAT type that is used. Not used in any business logic in SuperOffice; available to document templates.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)