Class QuoteAlternativeRow

Quote Version is made up of one or more Alternatives. One of 1..n possible alternatives in a Quote Version. The reason we have alternatives is that a quote can say to a customer, “we can solve you problem in two (or more) different ways, with different technology and sideeffects (and price)”. An Alternative may have discounts on the total amount. The Alternative tracks whether the user on the order level entered the Discount , Earning amount or the TotalPrice fields so that the discount and earning and total can be re-calculated correctly when Quote Lines are added or changed.
Row Object for table 'QuoteAlternative'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
QuoteAlternativeRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class QuoteAlternativeRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks

Row objects can be created in several ways.

  • Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
  • You can create a (nested) QuoteAlternativeRow QuoteAlternativeRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(QuoteAlternativeRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
  • For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
  • Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the QuoteAlternativeTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, QuoteAlternativeTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Non-unique indexes are handled through the QuoteAlternativeRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, QuoteAlternativeTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table QuoteAlternative are:

Index fieldsNested index class name

Constructors

QuoteAlternativeRow(QuoteAlternativeRow.QuoteAlternativeRowIdxBase)

Constructor for the class taking an index as argument. Quote Version is made up of one or more Alternatives. One of 1..n possible alternatives in a Quote Version. The reason we have alternatives is that a quote can say to a customer, “we can solve you problem in two (or more) different ways, with different technology and sideeffects (and price)”. An Alternative may have discounts on the total amount. The Alternative tracks whether the user on the order level entered the Discount , Earning amount or the TotalPrice fields so that the discount and earning and total can be re-calculated correctly when Quote Lines are added or changed.

Declaration
protected QuoteAlternativeRow(QuoteAlternativeRow.QuoteAlternativeRowIdxBase idx)
Parameters
Type Name Description
QuoteAlternativeRow.QuoteAlternativeRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentDiscountAmount

Current value, see property DiscountAmount.

Declaration
protected double _currentDiscountAmount
Field Value
Type Description
Double

_currentDiscountPercent

Current value, see property DiscountPercent.

Declaration
protected double _currentDiscountPercent
Field Value
Type Description
Double

_currentEarningAmount

Current value, see property EarningAmount.

Declaration
protected double _currentEarningAmount
Field Value
Type Description
Double

_currentEarningPercent

Current value, see property EarningPercent.

Declaration
protected double _currentEarningPercent
Field Value
Type Description
Double

_currentERPDiscountAmount

Current value, see property ERPDiscountAmount.

Declaration
protected double _currentERPDiscountAmount
Field Value
Type Description
Double

_currentERPDiscountPercent

Current value, see property ERPDiscountPercent.

Declaration
protected double _currentERPDiscountPercent
Field Value
Type Description
Double

_currentERPQuoteAlternativeKey

Current value, see property ERPQuoteAlternativeKey.

Declaration
protected string _currentERPQuoteAlternativeKey
Field Value
Type Description
String

_currentExtraField1

Current value, see property ExtraField1.

Declaration
protected string _currentExtraField1
Field Value
Type Description
String

_currentExtraField2

Current value, see property ExtraField2.

Declaration
protected string _currentExtraField2
Field Value
Type Description
String

_currentExtraField3

Current value, see property ExtraField3.

Declaration
protected string _currentExtraField3
Field Value
Type Description
String

_currentExtraField4

Current value, see property ExtraField4.

Declaration
protected string _currentExtraField4
Field Value
Type Description
String

_currentExtraField5

Current value, see property ExtraField5.

Declaration
protected string _currentExtraField5
Field Value
Type Description
String

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentQuoteAlternativeId

Current value, see property QuoteAlternativeId.

Declaration
protected int _currentQuoteAlternativeId
Field Value
Type Description
Int32

_currentQuoteVersionId

Current value, see property QuoteVersionId.

Declaration
protected int _currentQuoteVersionId
Field Value
Type Description
Int32

_currentReason

Current value, see property Reason.

Declaration
protected string _currentReason
Field Value
Type Description
String

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
Int32

_currentStatus

Current value, see property Status.

Declaration
protected QuoteStatus _currentStatus
Field Value
Type Description
QuoteStatus

_currentTotalPrice

Current value, see property TotalPrice.

Declaration
protected double _currentTotalPrice
Field Value
Type Description
Double

_currentUpdated

Current value, see property Updated.

Declaration
protected DateTime _currentUpdated
Field Value
Type Description
DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration
protected int _currentUpdatedAssociateId
Field Value
Type Description
Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration
protected short _currentUpdatedCount
Field Value
Type Description
Int16

_currentUserValueOverride

Current value, see property UserValueOverride.

Declaration
protected ValueOverride _currentUserValueOverride
Field Value
Type Description
ValueOverride

_currentVAT

Current value, see property VAT.

Declaration
protected double _currentVAT
Field Value
Type Description
Double

_currentVATInfo

Current value, see property VATInfo.

Declaration
protected string _currentVATInfo
Field Value
Type Description
String

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedDiscountAmount

Persisted value, see property DiscountAmount.

Declaration
protected double _persistedDiscountAmount
Field Value
Type Description
Double

_persistedDiscountPercent

Persisted value, see property DiscountPercent.

Declaration
protected double _persistedDiscountPercent
Field Value
Type Description
Double

_persistedEarningAmount

Persisted value, see property EarningAmount.

Declaration
protected double _persistedEarningAmount
Field Value
Type Description
Double

_persistedEarningPercent

Persisted value, see property EarningPercent.

Declaration
protected double _persistedEarningPercent
Field Value
Type Description
Double

_persistedERPDiscountAmount

Persisted value, see property ERPDiscountAmount.

Declaration
protected double _persistedERPDiscountAmount
Field Value
Type Description
Double

_persistedERPDiscountPercent

Persisted value, see property ERPDiscountPercent.

Declaration
protected double _persistedERPDiscountPercent
Field Value
Type Description
Double

_persistedERPQuoteAlternativeKey

Persisted value, see property ERPQuoteAlternativeKey.

Declaration
protected string _persistedERPQuoteAlternativeKey
Field Value
Type Description
String

_persistedExtraField1

Persisted value, see property ExtraField1.

Declaration
protected string _persistedExtraField1
Field Value
Type Description
String

_persistedExtraField2

Persisted value, see property ExtraField2.

Declaration
protected string _persistedExtraField2
Field Value
Type Description
String

_persistedExtraField3

Persisted value, see property ExtraField3.

Declaration
protected string _persistedExtraField3
Field Value
Type Description
String

_persistedExtraField4

Persisted value, see property ExtraField4.

Declaration
protected string _persistedExtraField4
Field Value
Type Description
String

_persistedExtraField5

Persisted value, see property ExtraField5.

Declaration
protected string _persistedExtraField5
Field Value
Type Description
String

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedQuoteAlternativeId

Persisted value, see property QuoteAlternativeId.

Declaration
protected int _persistedQuoteAlternativeId
Field Value
Type Description
Int32

_persistedQuoteVersionId

Persisted value, see property QuoteVersionId.

Declaration
protected int _persistedQuoteVersionId
Field Value
Type Description
Int32

_persistedReason

Persisted value, see property Reason.

Declaration
protected string _persistedReason
Field Value
Type Description
String

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
Int32

_persistedStatus

Persisted value, see property Status.

Declaration
protected QuoteStatus _persistedStatus
Field Value
Type Description
QuoteStatus

_persistedTotalPrice

Persisted value, see property TotalPrice.

Declaration
protected double _persistedTotalPrice
Field Value
Type Description
Double

_persistedUpdated

Persisted value, see property Updated.

Declaration
protected DateTime _persistedUpdated
Field Value
Type Description
DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type Description
Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration
protected short _persistedUpdatedCount
Field Value
Type Description
Int16

_persistedUserValueOverride

Persisted value, see property UserValueOverride.

Declaration
protected ValueOverride _persistedUserValueOverride
Field Value
Type Description
ValueOverride

_persistedVAT

Persisted value, see property VAT.

Declaration
protected double _persistedVAT
Field Value
Type Description
Double

_persistedVATInfo

Persisted value, see property VATInfo.

Declaration
protected string _persistedVATInfo
Field Value
Type Description
String

Properties

Description

.NET type: string. The tool-tip to use in the user interface (on the tab, for instance).

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[2048].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

DiscountAmount

.NET type: double. The discount the sales rep specifies, in whatever currency the sale is in. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount amount value into this field.

Declaration
public virtual double DiscountAmount { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

DiscountPercent

.NET type: double. The discount the sales rep specifies, in percent. Both the two ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed. If this field is filled out by the user, it overrides the discount suggested by the connector. If the user has not filled any values, the system will copy the ERP discount percent value into this field. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

Declaration
public virtual double DiscountPercent { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

EarningAmount

.NET type: double. Earning on this alternative, as an absolute amount

Declaration
public virtual double EarningAmount { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

EarningPercent

.NET type: double. The earning on this alternative, in percent of total. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

Declaration
public virtual double EarningPercent { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ERPDiscountAmount

.NET type: double. The discount the system calculates based on customer /amount / whatever. Can be overridden by the user in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent.

Declaration
public virtual double ERPDiscountAmount { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ERPDiscountPercent

.NET type: double. The discount the system calculates based on customer /amount / whatever. Can be overridden by the sales rep in the field ‘DiscountPercent’ or ‘DiscountAmount’. Both the two ‘ERPDiscountPercent’ and ‘ERPDiscountAmount’ shall be filled out. If UserValueOverride is 'None', then the ERPDiscountAmount shall be copied into DiscountAmount and ERPDiscountPercent into DiscountPercent. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

Declaration
public virtual double ERPDiscountPercent { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ERPQuoteAlternativeKey

.NET type: string. Key that identifies this alternative in the ERP system, if it exists there.

Declaration
public virtual string ERPQuoteAlternativeKey { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[255].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ExtraField1

.NET type: string. Optional information added by Quote Connector; usable in the quote document merge process

Declaration
public virtual string ExtraField1 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[1024].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ExtraField2

.NET type: string. Optional information added by Quote Connector; usable in the quote document merge process

Declaration
public virtual string ExtraField2 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[1024].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ExtraField3

.NET type: string. Optional information added by Quote Connector; usable in the quote document merge process

Declaration
public virtual string ExtraField3 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[1024].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ExtraField4

.NET type: string. Optional information added by Quote Connector; usable in the quote document merge process

Declaration
public virtual string ExtraField4 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[1024].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ExtraField5

.NET type: string. Optional information added by Quote Connector; usable in the quote document merge process

Declaration
public virtual string ExtraField5 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[1024].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides

Item[String]

Get or set a value based on the name of the field.

Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type Name Description
String fieldName

Name of the field in the database
Property Value
Type Description
Object

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

Name

.NET type: string. Name of Alternative. Shown in tab in user interface, intentionally kept short

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[60].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

QuoteAlternativeId

.NET type: int. Primary key

Declaration
public virtual int QuoteAlternativeId { get; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: PK.

This field is the primary key and can only be read, never written.

This field is not protected by the Sentry system, and can always be read

QuoteAlternativeTableInfo

Get the QuoteAlternativeTableInfo object associated with the row.

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

QuoteVersionId

.NET type: int. The version that owns this alternative (the chain is Sale 1->1 Quote 1->+ QuoteVersion 1->+ QuoteAlternative.

Declaration
public virtual int QuoteVersionId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Reason

.NET type: string. If there was a problem, this field contains a localized explanation of the problem and possible steps to fix it that the user can be shown.

Declaration
public virtual string Reason { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[2048].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Registered

.NET type: DateTime. Registered when in UTC

Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

RegisteredAssociateId

.NET type: int. Registered by whom

Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Status

.NET type: QuoteStatus. If there was a problem with for instance calculation, this field is set to warning or error.

Declaration
public virtual QuoteStatus Status { get; set; }
Property Value
Type Description
QuoteStatus
Remarks

Original type in dictionary: Enum.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((short)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

TotalPrice

.NET type: double. Sum of the QuoteLines.TotalPrice - AlternativeDiscount or QuoteLines.TotalCost + Earning based on what, if anything, the user has entered last. Shall be calculated by the connector.

Declaration
public virtual double TotalPrice { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Updated

.NET type: DateTime. Last updated when in UTC

Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

UpdatedAssociateId

.NET type: int. Last updated by whom

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

UpdatedCount

.NET type: short. Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: UShort.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

UserValueOverride

.NET type: ValueOverride. Has the pre-calculated (from ERP) price information been overridden, and how. If the user has filled out the discountpercentage field, then the UserValueOverride field is set to OverridePercent. (The DiscountAmount, EarningPercent, EarningAmount and TotalPrice fields are calculated based on the discountPercent.)

Declaration
public virtual ValueOverride UserValueOverride { get; set; }
Property Value
Type Description
ValueOverride
Remarks

Original type in dictionary: Enum.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((short)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

VAT

.NET type: double. Tax/VAT - THIS IS AN AMOUNT, available as a merge field in the quote document. The SuperOffice quote connector will calculate this field based on the vat PERCENTAGES on the individual lines; other connectors may implement other algorithms at will.

Declaration
public virtual double VAT { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0.0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

VATInfo

.NET type: string. Extra info about VAT that the connector might insert. This field has no business logic in the CRM code, but is available as a merge field in the quote documents.

Declaration
public virtual string VATInfo { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[255].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Methods

CreateNew()

Create a new instance of the QuoteAlternativeRow object. Quote Version is made up of one or more Alternatives. One of 1..n possible alternatives in a Quote Version. The reason we have alternatives is that a quote can say to a customer, “we can solve you problem in two (or more) different ways, with different technology and sideeffects (and price)”. An Alternative may have discounts on the total amount. The Alternative tracks whether the user on the order level entered the Discount , Earning amount or the TotalPrice fields so that the discount and earning and total can be re-calculated correctly when Quote Lines are added or changed.

Declaration
public static QuoteAlternativeRow CreateNew()
Returns
Type Description
QuoteAlternativeRow

A new instance of the QuoteAlternativeRow object.

GetFromCustomSearch(QuoteAlternativeRow.CustomSearch)

Create a new instance of the QuoteAlternativeRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).

Declaration
public static QuoteAlternativeRow GetFromCustomSearch(QuoteAlternativeRow.CustomSearch query)
Parameters
Type Name Description
QuoteAlternativeRow.CustomSearch query

The custom search to execute against the database
Returns
Type Description
QuoteAlternativeRow

A new instance of the QuoteAlternativeRow object, reflecting the result of the query.

GetFromIdxQuoteAlternativeId(Int32)

Create a new instance of the QuoteAlternativeRow object, by querying the database table via the index 'IDXQuoteAlternativeId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static QuoteAlternativeRow GetFromIdxQuoteAlternativeId(int quoteAlternativeId)
Parameters
Type Name Description
Int32 quoteAlternativeId
Returns
Type Description
QuoteAlternativeRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the QuoteAlternative table. Non-unique indexes have corresponding inner classes and methods in the QuoteAlternativeRows collection, since they may return more than one row.

GetFromReader(SoDataReader, QuoteAlternativeTableInfo)

Create a new instance of the QuoteAlternativeRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Quote Version is made up of one or more Alternatives. One of 1..n possible alternatives in a Quote Version. The reason we have alternatives is that a quote can say to a customer, “we can solve you problem in two (or more) different ways, with different technology and sideeffects (and price)”. An Alternative may have discounts on the total amount. The Alternative tracks whether the user on the order level entered the Discount , Earning amount or the TotalPrice fields so that the discount and earning and total can be re-calculated correctly when Quote Lines are added or changed.

Declaration
public static QuoteAlternativeRow GetFromReader(SoDataReader reader, QuoteAlternativeTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
QuoteAlternativeTableInfo tableInfo

QuoteAlternativeTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
QuoteAlternativeRow

A new instance of the QuoteAlternativeRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Boolean

True if the value is known and sentry permits read.
Overrides

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.
TableInfo tableInfo

The TableInfo used for the SELECT statement.
Overrides

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.
Overrides
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)
Overrides

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle
Overrides

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.
Overrides

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation
Overrides

Events

_onDescriptionChange

Change envent for property Description; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onDescriptionChange
Event Type
Type Description
OnFieldChange<String>

_onDiscountAmountChange

Change envent for property DiscountAmount; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onDiscountAmountChange
Event Type
Type Description
OnFieldChange<Double>

_onDiscountPercentChange

Change envent for property DiscountPercent; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onDiscountPercentChange
Event Type
Type Description
OnFieldChange<Double>

_onEarningAmountChange

Change envent for property EarningAmount; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onEarningAmountChange
Event Type
Type Description
OnFieldChange<Double>

_onEarningPercentChange

Change envent for property EarningPercent; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onEarningPercentChange
Event Type
Type Description
OnFieldChange<Double>

_onERPDiscountAmountChange

Change envent for property ERPDiscountAmount; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onERPDiscountAmountChange
Event Type
Type Description
OnFieldChange<Double>

_onERPDiscountPercentChange

Change envent for property ERPDiscountPercent; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onERPDiscountPercentChange
Event Type
Type Description
OnFieldChange<Double>

_onERPQuoteAlternativeKeyChange

Change envent for property ERPQuoteAlternativeKey; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onERPQuoteAlternativeKeyChange
Event Type
Type Description
OnFieldChange<String>

_onExtraField1Change

Change envent for property ExtraField1; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onExtraField1Change
Event Type
Type Description
OnFieldChange<String>

_onExtraField2Change

Change envent for property ExtraField2; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onExtraField2Change
Event Type
Type Description
OnFieldChange<String>

_onExtraField3Change

Change envent for property ExtraField3; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onExtraField3Change
Event Type
Type Description
OnFieldChange<String>

_onExtraField4Change

Change envent for property ExtraField4; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onExtraField4Change
Event Type
Type Description
OnFieldChange<String>

_onExtraField5Change

Change envent for property ExtraField5; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onExtraField5Change
Event Type
Type Description
OnFieldChange<String>

_onNameChange

Change envent for property Name; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type Description
OnFieldChange<String>

_onQuoteVersionIdChange

Change envent for property QuoteVersionId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onQuoteVersionIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onReasonChange

Change envent for property Reason; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onReasonChange
Event Type
Type Description
OnFieldChange<String>

_onRegisteredAssociateIdChange

Change envent for property RegisteredAssociateId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onRegisteredAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onRegisteredChange

Change envent for property Registered; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onRegisteredChange
Event Type
Type Description
OnFieldChange<DateTime>

_onStatusChange

Change envent for property Status; field is of .NET type short.

Declaration
protected event OnFieldChange<QuoteStatus> _onStatusChange
Event Type
Type Description
OnFieldChange<QuoteStatus>

_onTotalPriceChange

Change envent for property TotalPrice; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onTotalPriceChange
Event Type
Type Description
OnFieldChange<Double>

_onUpdatedAssociateIdChange

Change envent for property UpdatedAssociateId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onUpdatedAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdatedChange

Change envent for property Updated; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onUpdatedChange
Event Type
Type Description
OnFieldChange<DateTime>

_onUpdatedCountChange

Change envent for property UpdatedCount; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onUpdatedCountChange
Event Type
Type Description
OnFieldChange<Int16>

_onUserValueOverrideChange

Change envent for property UserValueOverride; field is of .NET type short.

Declaration
protected event OnFieldChange<ValueOverride> _onUserValueOverrideChange
Event Type
Type Description
OnFieldChange<ValueOverride>

_onVATChange

Change envent for property VAT; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onVATChange
Event Type
Type Description
OnFieldChange<Double>

_onVATInfoChange

Change envent for property VATInfo; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onVATInfoChange
Event Type
Type Description
OnFieldChange<String>

OnDescriptionChange

Event raised when Description is changing.

Declaration
public event OnFieldChange<string> OnDescriptionChange
Event Type
Type Description
OnFieldChange<String>

OnDiscountAmountChange

Event raised when DiscountAmount is changing.

Declaration
public event OnFieldChange<double> OnDiscountAmountChange
Event Type
Type Description
OnFieldChange<Double>

OnDiscountPercentChange

Event raised when DiscountPercent is changing.

Declaration
public event OnFieldChange<double> OnDiscountPercentChange
Event Type
Type Description
OnFieldChange<Double>

OnEarningAmountChange

Event raised when EarningAmount is changing.

Declaration
public event OnFieldChange<double> OnEarningAmountChange
Event Type
Type Description
OnFieldChange<Double>

OnEarningPercentChange

Event raised when EarningPercent is changing.

Declaration
public event OnFieldChange<double> OnEarningPercentChange
Event Type
Type Description
OnFieldChange<Double>

OnERPDiscountAmountChange

Event raised when ERPDiscountAmount is changing.

Declaration
public event OnFieldChange<double> OnERPDiscountAmountChange
Event Type
Type Description
OnFieldChange<Double>

OnERPDiscountPercentChange

Event raised when ERPDiscountPercent is changing.

Declaration
public event OnFieldChange<double> OnERPDiscountPercentChange
Event Type
Type Description
OnFieldChange<Double>

OnERPQuoteAlternativeKeyChange

Event raised when ERPQuoteAlternativeKey is changing.

Declaration
public event OnFieldChange<string> OnERPQuoteAlternativeKeyChange
Event Type
Type Description
OnFieldChange<String>

OnExtraField1Change

Event raised when ExtraField1 is changing.

Declaration
public event OnFieldChange<string> OnExtraField1Change
Event Type
Type Description
OnFieldChange<String>

OnExtraField2Change

Event raised when ExtraField2 is changing.

Declaration
public event OnFieldChange<string> OnExtraField2Change
Event Type
Type Description
OnFieldChange<String>

OnExtraField3Change

Event raised when ExtraField3 is changing.

Declaration
public event OnFieldChange<string> OnExtraField3Change
Event Type
Type Description
OnFieldChange<String>

OnExtraField4Change

Event raised when ExtraField4 is changing.

Declaration
public event OnFieldChange<string> OnExtraField4Change
Event Type
Type Description
OnFieldChange<String>

OnExtraField5Change

Event raised when ExtraField5 is changing.

Declaration
public event OnFieldChange<string> OnExtraField5Change
Event Type
Type Description
OnFieldChange<String>

OnNameChange

Event raised when Name is changing.

Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type Description
OnFieldChange<String>

OnQuoteVersionIdChange

Event raised when QuoteVersionId is changing.

Declaration
public event OnFieldChange<int> OnQuoteVersionIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnReasonChange

Event raised when Reason is changing.

Declaration
public event OnFieldChange<string> OnReasonChange
Event Type
Type Description
OnFieldChange<String>

OnRegisteredAssociateIdChange

Event raised when RegisteredAssociateId is changing.

Declaration
public event OnFieldChange<int> OnRegisteredAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnRegisteredChange

Event raised when Registered is changing.

Declaration
public event OnFieldChange<DateTime> OnRegisteredChange
Event Type
Type Description
OnFieldChange<DateTime>

OnStatusChange

Event raised when Status is changing.

Declaration
public event OnFieldChange<QuoteStatus> OnStatusChange
Event Type
Type Description
OnFieldChange<QuoteStatus>

OnTotalPriceChange

Event raised when TotalPrice is changing.

Declaration
public event OnFieldChange<double> OnTotalPriceChange
Event Type
Type Description
OnFieldChange<Double>

OnUpdatedAssociateIdChange

Event raised when UpdatedAssociateId is changing.

Declaration
public event OnFieldChange<int> OnUpdatedAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdatedChange

Event raised when Updated is changing.

Declaration
public event OnFieldChange<DateTime> OnUpdatedChange
Event Type
Type Description
OnFieldChange<DateTime>

OnUpdatedCountChange

Event raised when UpdatedCount is changing.

Declaration
public event OnFieldChange<short> OnUpdatedCountChange
Event Type
Type Description
OnFieldChange<Int16>

OnUserValueOverrideChange

Event raised when UserValueOverride is changing.

Declaration
public event OnFieldChange<ValueOverride> OnUserValueOverrideChange
Event Type
Type Description
OnFieldChange<ValueOverride>

OnVATChange

Event raised when VAT is changing.

Declaration
public event OnFieldChange<double> OnVATChange
Event Type
Type Description
OnFieldChange<Double>

OnVATInfoChange

Event raised when VATInfo is changing.

Declaration
public event OnFieldChange<string> OnVATInfoChange
Event Type
Type Description
OnFieldChange<String>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)