Class SaleHistRow

Mirror image of the Sale table, providing a full transaction history. Every time you edit a sale, the previous record of the sale is moved here.
Row Object for table 'SaleHist'. 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

SaleHistRow

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Inherited Members

TableRowBase._saveOwner

TableRowBase._sentries

TableRowBase._onValueChange

TableRowBase._relatedNestedPersistMembers

TableRowBase._sqlType

TableRowBase.InternalSetValue(Int32, Object)

TableRowBase.InternalSetValue(SoField, Object)

TableRowBase.GetFieldValue(FieldInfo)

TableRowBase.GetKnownFields()

TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)

TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)

TableRowBase.IsGhostField(FieldInfo)

TableRowBase.RowLoad()

TableRowBase.RowLoad(ITableRowLoadHandler)

TableRowBase.OnLoaded(IdxBase)

TableRowBase.Load(IdxBase, SoDataReader)

TableRowBase.Load(SoDataReader, TableInfo)

TableRowBase.SetDefaults()

TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)

TableRowBase.SetSaveOwner(INestedPersist)

TableRowBase.Save()

TableRowBase.Delete()

TableRowBase.Validate()

TableRowBase.SetDirty(Int32, Object, Object)

TableRowBase.INestedPersist.OnPreIdUpdate()

TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)

TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)

TableRowBase.INestedPersist.OnIdUpdate()

TableRowBase.INestedPersist.OnSave(BatchSave)

TableRowBase.INestedPersist.OnSaved(Boolean)

TableRowBase.OnPreIdUpdate()

TableRowBase.OnPrimaryKeyRequest(PKContainer)

TableRowBase.OnPrimaryKeyUpdate(PKContainer)

TableRowBase.OnIdUpdate()

TableRowBase.BeginIgnoreSentryCheck()

TableRowBase.EndIgnoreSentryCheck()

TableRowBase.GetRelatedNestedPersist()

TableRowBase.Item[Int32]

TableRowBase.Item[SoField]

TableRowBase.Sentries

TableRowBase.ForeignKeyHelper

TableRowBase.IsDeleted

TableRowBase.IsSaving

TableRowBase.SqlType

TableRowBase.IsSentryIgnored

TableRowBase.IsMarkedForDelete

TableRowBase.OnValueChanged

TableRowBase.OnElementSaved

TableRowBase.OnElementIdUpdate

PrivateSave.GetTableInfos()

PrivateSave.CloneToBasicUpdatingQuery()

PrivateSave.OnUpdateField

SqlCommand.Origin

SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)

SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)

SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)

SqlCommand.ClearIgnoreAutoSentryTableInfos()

SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)

SqlCommand.GetPrivateSaves()

SqlCommand.GetInserts()

SqlCommand.GetUpdates()

SqlCommand.GetDeletes()

SqlCommand.GetSelect()

SqlCommand.AutoSentryIgnoredTables

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class SaleHistRow : 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) SaleHistRow SaleHistRow.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(SaleHistRow.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 SaleHistTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SaleHistTableInfo) 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 SaleHistRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, SaleHistTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table SaleHist are:

Index fields	Nested index class name

Constructors

SaleHistRow(SaleHistRow.SaleHistRowIdxBase)

Constructor for the class taking an index as argument. Mirror image of the Sale table, providing a full transaction history. Every time you edit a sale, the previous record of the sale is moved here.

Declaration

protected SaleHistRow(SaleHistRow.SaleHistRowIdxBase idx)

Parameters

Type	Name	Description
SaleHistRow.SaleHistRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentActiveLinks

Current value, see property ActiveLinks.

Declaration

protected uint _currentActiveLinks

Field Value

Type	Description
UInt32

_currentAmount

Current value, see property Amount.

Declaration

protected double _currentAmount

Field Value

Type	Description
Double

_currentAppointmentId

Current value, see property AppointmentId.

Declaration

protected int _currentAppointmentId

Field Value

Type	Description
Int32

_currentAssociateId

Current value, see property AssociateId.

Declaration

protected int _currentAssociateId

Field Value

Type	Description
Int32

_currentComptrId

Current value, see property ComptrId.

Declaration

protected int _currentComptrId

Field Value

Type	Description
Int32

_currentContactId

Current value, see property ContactId.

Declaration

protected int _currentContactId

Field Value

Type	Description
Int32

_currentCreditedId

Current value, see property CreditedId.

Declaration

protected int _currentCreditedId

Field Value

Type	Description
Int32

_currentCurrencyId

Current value, see property CurrencyId.

Declaration

protected int _currentCurrencyId

Field Value

Type	Description
Int32

_currentDone

Current value, see property Done.

Declaration

protected SaleDone _currentDone

Field Value

Type	Description
SaleDone

_currentEarning

Current value, see property Earning.

Declaration

protected double _currentEarning

Field Value

Type	Description
Double

_currentEarningPercent

Current value, see property EarningPercent.

Declaration

protected double _currentEarningPercent

Field Value

Type	Description
Double

_currentGroupIdx

Current value, see property GroupIdx.

Declaration

protected int _currentGroupIdx

Field Value

Type	Description
Int32

_currentHeading

Current value, see property Heading.

Declaration

protected string _currentHeading

Field Value

Type	Description
String

_currentNddAppointmentId

Current value, see property NddAppointmentId.

Declaration

protected int _currentNddAppointmentId

Field Value

Type	Description
Int32

_currentNextDueDate

Current value, see property NextDueDate.

Declaration

protected DateTime _currentNextDueDate

Field Value

Type	Description
DateTime

_currentNumber1

Current value, see property Number1.

Declaration

protected string _currentNumber1

Field Value

Type	Description
String

_currentPersonId

Current value, see property PersonId.

Declaration

protected int _currentPersonId

Field Value

Type	Description
Int32

_currentPostitTextId

Current value, see property PostitTextId.

Declaration

protected int _currentPostitTextId

Field Value

Type	Description
Int32

_currentProbability

Current value, see property Probability.

Declaration

protected short _currentProbability

Field Value

Type	Description
Int16

_currentProbabilityIdx

Current value, see property ProbabilityIdx.

Declaration

protected int _currentProbabilityIdx

Field Value

Type	Description
Int32

_currentProjectId

Current value, see property ProjectId.

Declaration

protected int _currentProjectId

Field Value

Type	Description
Int32

_currentReasonId

Current value, see property ReasonId.

Declaration

protected int _currentReasonId

Field Value

Type	Description
Int32

_currentReasonSoldId

Current value, see property ReasonSoldId.

Declaration

protected int _currentReasonSoldId

Field Value

Type	Description
Int32

_currentReasonStalledId

Current value, see property ReasonStalledId.

Declaration

protected int _currentReasonStalledId

Field Value

Type	Description
Int32

_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

_currentReopenDate

Current value, see property ReopenDate.

Declaration

protected DateTime _currentReopenDate

Field Value

Type	Description
DateTime

_currentSaledate

Current value, see property Saledate.

Declaration

protected DateTime _currentSaledate

Field Value

Type	Description
DateTime

_currentSalehistId

Current value, see property SalehistId.

Declaration

protected int _currentSalehistId

Field Value

Type	Description
Int32

_currentSaleId

Current value, see property SaleId.

Declaration

protected int _currentSaleId

Field Value

Type	Description
Int32

_currentSaleTypeCatId

Current value, see property SaleTypeCatId.

Declaration

protected int _currentSaleTypeCatId

Field Value

Type	Description
Int32

_currentSaleTypeId

Current value, see property SaleTypeId.

Declaration

protected int _currentSaleTypeId

Field Value

Type	Description
Int32

_currentSource

Current value, see property Source.

Declaration

protected short _currentSource

Field Value

Type	Description
Int16

_currentSourceId

Current value, see property SourceId.

Declaration

protected int _currentSourceId

Field Value

Type	Description
Int32

_currentStatus

Current value, see property Status.

Declaration

protected SaleStatus _currentStatus

Field Value

Type	Description
SaleStatus

_currentTextId

Current value, see property TextId.

Declaration

protected int _currentTextId

Field Value

Type	Description
Int32

_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

_currentUserdef2Id

Current value, see property Userdef2Id.

Declaration

protected int _currentUserdef2Id

Field Value

Type	Description
Int32

_currentUserdefId

Current value, see property UserdefId.

Declaration

protected int _currentUserdefId

Field Value

Type	Description
Int32

_currentVisibility

Current value, see property Visibility.

Declaration

protected short _currentVisibility

Field Value

Type	Description
Int16

_persistedActiveLinks

Persisted value, see property ActiveLinks.

Declaration

protected uint _persistedActiveLinks

Field Value

Type	Description
UInt32

_persistedAmount

Persisted value, see property Amount.

Declaration

protected double _persistedAmount

Field Value

Type	Description
Double

_persistedAppointmentId

Persisted value, see property AppointmentId.

Declaration

protected int _persistedAppointmentId

Field Value

Type	Description
Int32

_persistedAssociateId

Persisted value, see property AssociateId.

Declaration

protected int _persistedAssociateId

Field Value

Type	Description
Int32

_persistedComptrId

Persisted value, see property ComptrId.

Declaration

protected int _persistedComptrId

Field Value

Type	Description
Int32

_persistedContactId

Persisted value, see property ContactId.

Declaration

protected int _persistedContactId

Field Value

Type	Description
Int32

_persistedCreditedId

Persisted value, see property CreditedId.

Declaration

protected int _persistedCreditedId

Field Value

Type	Description
Int32

_persistedCurrencyId

Persisted value, see property CurrencyId.

Declaration

protected int _persistedCurrencyId

Field Value

Type	Description
Int32

_persistedDone

Persisted value, see property Done.

Declaration

protected SaleDone _persistedDone

Field Value

Type	Description
SaleDone

_persistedEarning

Persisted value, see property Earning.

Declaration

protected double _persistedEarning

Field Value

Type	Description
Double

_persistedEarningPercent

Persisted value, see property EarningPercent.

Declaration

protected double _persistedEarningPercent

Field Value

Type	Description
Double

_persistedGroupIdx

Persisted value, see property GroupIdx.

Declaration

protected int _persistedGroupIdx

Field Value

Type	Description
Int32

_persistedHeading

Persisted value, see property Heading.

Declaration

protected string _persistedHeading

Field Value

Type	Description
String

_persistedNddAppointmentId

Persisted value, see property NddAppointmentId.

Declaration

protected int _persistedNddAppointmentId

Field Value

Type	Description
Int32

_persistedNextDueDate

Persisted value, see property NextDueDate.

Declaration

protected DateTime _persistedNextDueDate

Field Value

Type	Description
DateTime

_persistedNumber1

Persisted value, see property Number1.

Declaration

protected string _persistedNumber1

Field Value

Type	Description
String

_persistedPersonId

Persisted value, see property PersonId.

Declaration

protected int _persistedPersonId

Field Value

Type	Description
Int32

_persistedPostitTextId

Persisted value, see property PostitTextId.

Declaration

protected int _persistedPostitTextId

Field Value

Type	Description
Int32

_persistedProbability

Persisted value, see property Probability.

Declaration

protected short _persistedProbability

Field Value

Type	Description
Int16

_persistedProbabilityIdx

Persisted value, see property ProbabilityIdx.

Declaration

protected int _persistedProbabilityIdx

Field Value

Type	Description
Int32

_persistedProjectId

Persisted value, see property ProjectId.

Declaration

protected int _persistedProjectId

Field Value

Type	Description
Int32

_persistedReasonId

Persisted value, see property ReasonId.

Declaration

protected int _persistedReasonId

Field Value

Type	Description
Int32

_persistedReasonSoldId

Persisted value, see property ReasonSoldId.

Declaration

protected int _persistedReasonSoldId

Field Value

Type	Description
Int32

_persistedReasonStalledId

Persisted value, see property ReasonStalledId.

Declaration

protected int _persistedReasonStalledId

Field Value

Type	Description
Int32

_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

_persistedReopenDate

Persisted value, see property ReopenDate.

Declaration

protected DateTime _persistedReopenDate

Field Value

Type	Description
DateTime

_persistedSaledate

Persisted value, see property Saledate.

Declaration

protected DateTime _persistedSaledate

Field Value

Type	Description
DateTime

_persistedSalehistId

Persisted value, see property SalehistId.

Declaration

protected int _persistedSalehistId

Field Value

Type	Description
Int32

_persistedSaleId

Persisted value, see property SaleId.

Declaration

protected int _persistedSaleId

Field Value

Type	Description
Int32

_persistedSaleTypeCatId

Persisted value, see property SaleTypeCatId.

Declaration

protected int _persistedSaleTypeCatId

Field Value

Type	Description
Int32

_persistedSaleTypeId

Persisted value, see property SaleTypeId.

Declaration

protected int _persistedSaleTypeId

Field Value

Type	Description
Int32

_persistedSource

Persisted value, see property Source.

Declaration

protected short _persistedSource

Field Value

Type	Description
Int16

_persistedSourceId

Persisted value, see property SourceId.

Declaration

protected int _persistedSourceId

Field Value

Type	Description
Int32

_persistedStatus

Persisted value, see property Status.

Declaration

protected SaleStatus _persistedStatus

Field Value

Type	Description
SaleStatus

_persistedTextId

Persisted value, see property TextId.

Declaration

protected int _persistedTextId

Field Value

Type	Description
Int32

_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

_persistedUserdef2Id

Persisted value, see property Userdef2Id.

Declaration

protected int _persistedUserdef2Id

Field Value

Type	Description
Int32

_persistedUserdefId

Persisted value, see property UserdefId.

Declaration

protected int _persistedUserdefId

Field Value

Type	Description
Int32

_persistedVisibility

Persisted value, see property Visibility.

Declaration

protected short _persistedVisibility

Field Value

Type	Description
Int16

Properties

ActiveLinks

.NET type: uint. Number of active links to documents and such

Declaration

public virtual uint ActiveLinks { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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 ((UInt32)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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Amount

.NET type: double. Total sale amount

Declaration

public virtual double Amount { get; set; }

Property Value

Type	Description
Double

Remarks

Original type in dictionary: Double.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

AppointmentId

.NET type: int. For future use

Declaration

public virtual int AppointmentId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

AssociateId

.NET type: int. Owning associate

Declaration

public virtual int AssociateId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

Setting this field to a new value will reset the Sentry and recalculate your rights based on the new value

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)

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ComptrId

.NET type: int. Competitor

Declaration

public virtual int ComptrId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ContactId

.NET type: int. Optional contact reference

Declaration

public virtual int ContactId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

CreditedId

.NET type: int. Who is to be credited for the sale

Declaration

public virtual int CreditedId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

CurrencyId

.NET type: int. Currency of sale

Declaration

public virtual int CurrencyId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Done

.NET type: SaleDone. Done (0=don't know, 1 = No, 2=Yes)

Declaration

public virtual SaleDone Done { get; set; }

Property Value

Type	Description
SaleDone

Remarks

Original type in dictionary: Enum.

Read only for code not signed by SuperOffice.

Setting this field to a new value will reset the Sentry and recalculate your rights based on the new value

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)

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Earning

.NET type: double. Earning on sale

Declaration

public virtual double Earning { get; set; }

Property Value

Type	Description
Double

Remarks

Original type in dictionary: Double.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

EarningPercent

.NET type: double. Earning as percent of total

Declaration

public virtual double EarningPercent { get; set; }

Property Value

Type	Description
Double

Remarks

Original type in dictionary: Double.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

GroupIdx

.NET type: int. Owner's group whn sale was created

Declaration

public virtual int GroupIdx { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

Setting this field to a new value will reset the Sentry and recalculate your rights based on the new value

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)

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Heading

.NET type: string. Sale heading (short description?)

Declaration

public virtual string Heading { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[220].

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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

PrivateSave.InnerFieldValuePairs

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

PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration

protected override Parameter InnerPrimaryKeyValue { get; }

Property Value

Type	Description
Parameter

Overrides

PrivateSave.InnerPrimaryKeyValue

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

TableRowBase.IsDirty

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

TableRowBase.IsNew

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

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

NddAppointmentId

.NET type: int. ID, can be 0, of the appointment that "caused" the nextDueDate

Declaration

public virtual int NddAppointmentId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

NextDueDate

.NET type: DateTime. Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching.

Declaration

public virtual DateTime NextDueDate { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Number1

.NET type: string. Alphanumeric user field

Declaration

public virtual string Number1 { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[50].

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

PersonId

.NET type: int. Optional person reference

Declaration

public virtual int PersonId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

PostitTextId

.NET type: int. Paperclip text

Declaration

public virtual int PostitTextId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Probability

.NET type: short. Actual probability, may differ from the one in the list

Declaration

public virtual short Probability { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ProbabilityIdx

.NET type: int. Pointer to probability list value

Declaration

public virtual int ProbabilityIdx { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ProjectId

.NET type: int. Optional project reference

Declaration

public virtual int ProjectId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ReasonId

.NET type: int. Why we lost it

Declaration

public virtual int ReasonId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ReasonSoldId

.NET type: int. Reason why we made the sale

Declaration

public virtual int ReasonSoldId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ReasonStalledId

.NET type: int. If the status is stalled, it should be commented here

Declaration

public virtual int ReasonStalledId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Registered

.NET type: DateTime. Registered date in UTC

Declaration

public virtual DateTime Registered { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: UtcDateTime.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ReopenDate

.NET type: DateTime. Date the sale is to be reopened; valid only for status=stalled. Not necessarily the same as the nextDueDate.

Declaration

public virtual DateTime ReopenDate { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Saledate

.NET type: DateTime. (expected | lost | won) sales date

Declaration

public virtual DateTime Saledate { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

SalehistId

.NET type: int. Primary key

Declaration

public virtual int SalehistId { 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.

Read only for code not signed by SuperOffice.

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

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.

SaleHistTableInfo

Get the SaleHistTableInfo object associated with the row.

Declaration

public SaleHistTableInfo SaleHistTableInfo { get; }

Property Value

Type	Description
SaleHistTableInfo

SaleId

.NET type: int. The sale

Declaration

public virtual int SaleId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.

SaleTypeCatId

.NET type: int. Category of sale type, slaved from saletype

Declaration

public virtual int SaleTypeCatId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

SaleTypeId

.NET type: int. Link to list, sale type (big sale, small sale, no-process sale, ...)

Declaration

public virtual int SaleTypeId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Source

.NET type: short. For future integration use; source of record

Declaration

public virtual short Source { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

SourceId

.NET type: int. Source of order

Declaration

public virtual int SourceId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Status

.NET type: SaleStatus. Status (open, closed, lost)

Declaration

public virtual SaleStatus Status { get; set; }

Property Value

Type	Description
SaleStatus

Remarks

Original type in dictionary: Enum.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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

TableRowBase.TableInfo

TextId

.NET type: int. Optional long description

Declaration

public virtual int TextId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Updated

.NET type: DateTime. Last updated in UTC

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: UtcDateTime.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Userdef2Id

.NET type: int. User-defined fields reference

Declaration

public virtual int Userdef2Id { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

UserdefId

.NET type: int. User-defined fields reference

Declaration

public virtual int UserdefId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Visibility

.NET type: short. Obsolete, but still maintained denormalization of visiblefor

Declaration

public virtual short Visibility { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
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 SaleHistRow object. Mirror image of the Sale table, providing a full transaction history. Every time you edit a sale, the previous record of the sale is moved here.

Declaration

public static SaleHistRow CreateNew()

Returns

Type	Description
SaleHistRow	A new instance of the SaleHistRow object.

GetFromCustomSearch(SaleHistRow.CustomSearch)

Create a new instance of the SaleHistRow 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 SaleHistRow GetFromCustomSearch(SaleHistRow.CustomSearch query)

Parameters

Type	Name	Description
SaleHistRow.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
SaleHistRow	A new instance of the SaleHistRow object, reflecting the result of the query.

GetFromIdxSalehistId(Int32)

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

Declaration

public static SaleHistRow GetFromIdxSalehistId(int salehistId)

Parameters

Type	Name	Description
Int32	salehistId

Returns

Type	Description
SaleHistRow	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 SaleHist table. Non-unique indexes have corresponding inner classes and methods in the SaleHistRows collection, since they may return more than one row.

GetFromReader(SoDataReader, SaleHistTableInfo)

Create a new instance of the SaleHistRow 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. Mirror image of the Sale table, providing a full transaction history. Every time you edit a sale, the previous record of the sale is moved here.

Declaration

public static SaleHistRow GetFromReader(SoDataReader reader, SaleHistTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
SaleHistTableInfo	tableInfo	SaleHistTableInfo 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
SaleHistRow	A new instance of the SaleHistRow 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

PrivateSave.GetPersistedFieldValue(FieldInfo)

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

TableRowBase.InternalSetValue(String, Object)

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

PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

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

TableRowBase.OnLoad(SoDataReader, TableInfo)

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

TableRowBase.OnSave(BatchSave)

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

TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration

protected override void Reset()

Overrides

TableRowBase.Reset()

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

TableRowBase.SetDefaults(DefaulterStrategy)

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

TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration

public override void SetRowAsNew()

Overrides

TableRowBase.SetRowAsNew()

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

Object.ToString()

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

TableRowBase.Validate(RowValidator)

Events

_onActiveLinksChange

Change envent for property ActiveLinks; field is of .NET type uint.

Declaration

protected event OnFieldChange<uint> _onActiveLinksChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onAmountChange

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

Declaration

protected event OnFieldChange<double> _onAmountChange

Event Type

Type	Description
OnFieldChange<Double>

_onAppointmentIdChange

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

Declaration

protected event OnFieldChange<int> _onAppointmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onAssociateIdChange

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

Declaration

protected event OnFieldChange<int> _onAssociateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onComptrIdChange

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

Declaration

protected event OnFieldChange<int> _onComptrIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onContactIdChange

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

Declaration

protected event OnFieldChange<int> _onContactIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onCreditedIdChange

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

Declaration

protected event OnFieldChange<int> _onCreditedIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onCurrencyIdChange

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

Declaration

protected event OnFieldChange<int> _onCurrencyIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onDoneChange

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

Declaration

protected event OnFieldChange<SaleDone> _onDoneChange

Event Type

Type	Description
OnFieldChange<SaleDone>

_onEarningChange

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

Declaration

protected event OnFieldChange<double> _onEarningChange

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>

_onGroupIdxChange

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

Declaration

protected event OnFieldChange<int> _onGroupIdxChange

Event Type

Type	Description
OnFieldChange<Int32>

_onHeadingChange

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

Declaration

protected event OnFieldChange<string> _onHeadingChange

Event Type

Type	Description
OnFieldChange<String>

_onNddAppointmentIdChange

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

Declaration

protected event OnFieldChange<int> _onNddAppointmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onNextDueDateChange

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

Declaration

protected event OnFieldChange<DateTime> _onNextDueDateChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onNumber1Change

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

Declaration

protected event OnFieldChange<string> _onNumber1Change

Event Type

Type	Description
OnFieldChange<String>

_onPersonIdChange

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

Declaration

protected event OnFieldChange<int> _onPersonIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onPostitTextIdChange

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

Declaration

protected event OnFieldChange<int> _onPostitTextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onProbabilityChange

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

Declaration

protected event OnFieldChange<short> _onProbabilityChange

Event Type

Type	Description
OnFieldChange<Int16>

_onProbabilityIdxChange

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

Declaration

protected event OnFieldChange<int> _onProbabilityIdxChange

Event Type

Type	Description
OnFieldChange<Int32>

_onProjectIdChange

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

Declaration

protected event OnFieldChange<int> _onProjectIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onReasonIdChange

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

Declaration

protected event OnFieldChange<int> _onReasonIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onReasonSoldIdChange

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

Declaration

protected event OnFieldChange<int> _onReasonSoldIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onReasonStalledIdChange

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

Declaration

protected event OnFieldChange<int> _onReasonStalledIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_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>

_onReopenDateChange

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

Declaration

protected event OnFieldChange<DateTime> _onReopenDateChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onSaledateChange

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

Declaration

protected event OnFieldChange<DateTime> _onSaledateChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onSaleIdChange

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

Declaration

protected event OnFieldChange<int> _onSaleIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onSaleTypeCatIdChange

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

Declaration

protected event OnFieldChange<int> _onSaleTypeCatIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onSaleTypeIdChange

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

Declaration

protected event OnFieldChange<int> _onSaleTypeIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onSourceChange

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

Declaration

protected event OnFieldChange<short> _onSourceChange

Event Type

Type	Description
OnFieldChange<Int16>

_onSourceIdChange

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

Declaration

protected event OnFieldChange<int> _onSourceIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onStatusChange

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

Declaration

protected event OnFieldChange<SaleStatus> _onStatusChange

Event Type

Type	Description
OnFieldChange<SaleStatus>

_onTextIdChange

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

Declaration

protected event OnFieldChange<int> _onTextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_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>

_onUserdef2IdChange

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

Declaration

protected event OnFieldChange<int> _onUserdef2IdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onUserdefIdChange

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

Declaration

protected event OnFieldChange<int> _onUserdefIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onVisibilityChange

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

Declaration

protected event OnFieldChange<short> _onVisibilityChange

Event Type

Type	Description
OnFieldChange<Int16>

OnActiveLinksChange

Event raised when ActiveLinks is changing.

Declaration

public event OnFieldChange<uint> OnActiveLinksChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnAmountChange

Event raised when Amount is changing.

Declaration

public event OnFieldChange<double> OnAmountChange

Event Type

Type	Description
OnFieldChange<Double>

OnAppointmentIdChange

Event raised when AppointmentId is changing.

Declaration

public event OnFieldChange<int> OnAppointmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnAssociateIdChange

Event raised when AssociateId is changing.

Declaration

public event OnFieldChange<int> OnAssociateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnComptrIdChange

Event raised when ComptrId is changing.

Declaration

public event OnFieldChange<int> OnComptrIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnContactIdChange

Event raised when ContactId is changing.

Declaration

public event OnFieldChange<int> OnContactIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnCreditedIdChange

Event raised when CreditedId is changing.

Declaration

public event OnFieldChange<int> OnCreditedIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnCurrencyIdChange

Event raised when CurrencyId is changing.

Declaration

public event OnFieldChange<int> OnCurrencyIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnDoneChange

Event raised when Done is changing.

Declaration

public event OnFieldChange<SaleDone> OnDoneChange

Event Type

Type	Description
OnFieldChange<SaleDone>

OnEarningChange

Event raised when Earning is changing.

Declaration

public event OnFieldChange<double> OnEarningChange

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>

OnGroupIdxChange

Event raised when GroupIdx is changing.

Declaration

public event OnFieldChange<int> OnGroupIdxChange

Event Type

Type	Description
OnFieldChange<Int32>

OnHeadingChange

Event raised when Heading is changing.

Declaration

public event OnFieldChange<string> OnHeadingChange

Event Type

Type	Description
OnFieldChange<String>

OnNddAppointmentIdChange

Event raised when NddAppointmentId is changing.

Declaration

public event OnFieldChange<int> OnNddAppointmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnNextDueDateChange

Event raised when NextDueDate is changing.

Declaration

public event OnFieldChange<DateTime> OnNextDueDateChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnNumber1Change

Event raised when Number1 is changing.

Declaration

public event OnFieldChange<string> OnNumber1Change

Event Type

Type	Description
OnFieldChange<String>

OnPersonIdChange

Event raised when PersonId is changing.

Declaration

public event OnFieldChange<int> OnPersonIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnPostitTextIdChange

Event raised when PostitTextId is changing.

Declaration

public event OnFieldChange<int> OnPostitTextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnProbabilityChange

Event raised when Probability is changing.

Declaration

public event OnFieldChange<short> OnProbabilityChange

Event Type

Type	Description
OnFieldChange<Int16>

OnProbabilityIdxChange

Event raised when ProbabilityIdx is changing.

Declaration

public event OnFieldChange<int> OnProbabilityIdxChange

Event Type

Type	Description
OnFieldChange<Int32>

OnProjectIdChange

Event raised when ProjectId is changing.

Declaration

public event OnFieldChange<int> OnProjectIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnReasonIdChange

Event raised when ReasonId is changing.

Declaration

public event OnFieldChange<int> OnReasonIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnReasonSoldIdChange

Event raised when ReasonSoldId is changing.

Declaration

public event OnFieldChange<int> OnReasonSoldIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnReasonStalledIdChange

Event raised when ReasonStalledId is changing.

Declaration

public event OnFieldChange<int> OnReasonStalledIdChange

Event Type

Type	Description
OnFieldChange<Int32>

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>

OnReopenDateChange

Event raised when ReopenDate is changing.

Declaration

public event OnFieldChange<DateTime> OnReopenDateChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnSaledateChange

Event raised when Saledate is changing.

Declaration

public event OnFieldChange<DateTime> OnSaledateChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnSaleIdChange

Event raised when SaleId is changing.

Declaration

public event OnFieldChange<int> OnSaleIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnSaleTypeCatIdChange

Event raised when SaleTypeCatId is changing.

Declaration

public event OnFieldChange<int> OnSaleTypeCatIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnSaleTypeIdChange

Event raised when SaleTypeId is changing.

Declaration

public event OnFieldChange<int> OnSaleTypeIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnSourceChange

Event raised when Source is changing.

Declaration

public event OnFieldChange<short> OnSourceChange

Event Type

Type	Description
OnFieldChange<Int16>

OnSourceIdChange

Event raised when SourceId is changing.

Declaration

public event OnFieldChange<int> OnSourceIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnStatusChange

Event raised when Status is changing.

Declaration

public event OnFieldChange<SaleStatus> OnStatusChange

Event Type

Type	Description
OnFieldChange<SaleStatus>

OnTextIdChange

Event raised when TextId is changing.

Declaration

public event OnFieldChange<int> OnTextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

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>

OnUserdef2IdChange

Event raised when Userdef2Id is changing.

Declaration

public event OnFieldChange<int> OnUserdef2IdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnUserdefIdChange

Event raised when UserdefId is changing.

Declaration

public event OnFieldChange<int> OnUserdefIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnVisibilityChange

Event raised when Visibility is changing.

Declaration

public event OnFieldChange<short> OnVisibilityChange

Event Type

Type	Description
OnFieldChange<Int16>

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)

QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)

QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)

QueryExectionExtensions.ExecuteNonQuery(SqlCommand)

Converters.MapEnums<From, To>(From)