Class CounterValueRow

Visible for rights
Row Object for table 'CounterValue'. 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

CounterValueRow

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

Unique indexes on table CounterValue are:

Index fields	Nested index class name

Constructors

CounterValueRow(CounterValueRow.CounterValueRowIdxBase)

Constructor for the class taking an index as argument. Visible for rights

Declaration

protected CounterValueRow(CounterValueRow.CounterValueRowIdxBase idx)

Parameters

Type	Name	Description
CounterValueRow.CounterValueRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAmountClassId

Current value, see property AmountClassId.

Declaration

protected int _currentAmountClassId

Field Value

Type	Description
Int32

_currentContactId

Current value, see property ContactId.

Declaration

protected int _currentContactId

Field Value

Type	Description
Int32

_currentCounterValueId

Current value, see property CounterValueId.

Declaration

protected int _currentCounterValueId

Field Value

Type	Description
Int32

_currentDirection

Current value, see property Direction.

Declaration

protected short _currentDirection

Field Value

Type	Description
Int16

_currentExtra1Count

Current value, see property Extra1Count.

Declaration

protected uint _currentExtra1Count

Field Value

Type	Description
UInt32

_currentExtra1Id

Current value, see property Extra1Id.

Declaration

protected int _currentExtra1Id

Field Value

Type	Description
Int32

_currentExtra2Count

Current value, see property Extra2Count.

Declaration

protected uint _currentExtra2Count

Field Value

Type	Description
UInt32

_currentExtra2Id

Current value, see property Extra2Id.

Declaration

protected int _currentExtra2Id

Field Value

Type	Description
Int32

_currentExtra3Count

Current value, see property Extra3Count.

Declaration

protected uint _currentExtra3Count

Field Value

Type	Description
UInt32

_currentExtra4Count

Current value, see property Extra4Count.

Declaration

protected uint _currentExtra4Count

Field Value

Type	Description
UInt32

_currentIntentId

Current value, see property IntentId.

Declaration

protected int _currentIntentId

Field Value

Type	Description
Int32

_currentLastCompleted

Current value, see property LastCompleted.

Declaration

protected DateTime _currentLastCompleted

Field Value

Type	Description
DateTime

_currentLastDoBy

Current value, see property LastDoBy.

Declaration

protected DateTime _currentLastDoBy

Field Value

Type	Description
DateTime

_currentLastRegistered

Current value, see property LastRegistered.

Declaration

protected DateTime _currentLastRegistered

Field Value

Type	Description
DateTime

_currentNotCompleted

Current value, see property NotCompleted.

Declaration

protected uint _currentNotCompleted

Field Value

Type	Description
UInt32

_currentNotCompletedInPeriod

Current value, see property NotCompletedInPeriod.

Declaration

protected uint _currentNotCompletedInPeriod

Field Value

Type	Description
UInt32

_currentPersonId

Current value, see property PersonId.

Declaration

protected int _currentPersonId

Field Value

Type	Description
Int32

_currentProjectId

Current value, see property ProjectId.

Declaration

protected int _currentProjectId

Field Value

Type	Description
Int32

_currentRecordType

Current value, see property RecordType.

Declaration

protected short _currentRecordType

Field Value

Type	Description
Int16

_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

_currentSaleStatus

Current value, see property SaleStatus.

Declaration

protected SaleStatus _currentSaleStatus

Field Value

Type	Description
SaleStatus

_currentTotalReg

Current value, see property TotalReg.

Declaration

protected uint _currentTotalReg

Field Value

Type	Description
UInt32

_currentTotalRegInPeriod

Current value, see property TotalRegInPeriod.

Declaration

protected uint _currentTotalRegInPeriod

Field Value

Type	Description
UInt32

_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

_persistedAmountClassId

Persisted value, see property AmountClassId.

Declaration

protected int _persistedAmountClassId

Field Value

Type	Description
Int32

_persistedContactId

Persisted value, see property ContactId.

Declaration

protected int _persistedContactId

Field Value

Type	Description
Int32

_persistedCounterValueId

Persisted value, see property CounterValueId.

Declaration

protected int _persistedCounterValueId

Field Value

Type	Description
Int32

_persistedDirection

Persisted value, see property Direction.

Declaration

protected short _persistedDirection

Field Value

Type	Description
Int16

_persistedExtra1Count

Persisted value, see property Extra1Count.

Declaration

protected uint _persistedExtra1Count

Field Value

Type	Description
UInt32

_persistedExtra1Id

Persisted value, see property Extra1Id.

Declaration

protected int _persistedExtra1Id

Field Value

Type	Description
Int32

_persistedExtra2Count

Persisted value, see property Extra2Count.

Declaration

protected uint _persistedExtra2Count

Field Value

Type	Description
UInt32

_persistedExtra2Id

Persisted value, see property Extra2Id.

Declaration

protected int _persistedExtra2Id

Field Value

Type	Description
Int32

_persistedExtra3Count

Persisted value, see property Extra3Count.

Declaration

protected uint _persistedExtra3Count

Field Value

Type	Description
UInt32

_persistedExtra4Count

Persisted value, see property Extra4Count.

Declaration

protected uint _persistedExtra4Count

Field Value

Type	Description
UInt32

_persistedIntentId

Persisted value, see property IntentId.

Declaration

protected int _persistedIntentId

Field Value

Type	Description
Int32

_persistedLastCompleted

Persisted value, see property LastCompleted.

Declaration

protected DateTime _persistedLastCompleted

Field Value

Type	Description
DateTime

_persistedLastDoBy

Persisted value, see property LastDoBy.

Declaration

protected DateTime _persistedLastDoBy

Field Value

Type	Description
DateTime

_persistedLastRegistered

Persisted value, see property LastRegistered.

Declaration

protected DateTime _persistedLastRegistered

Field Value

Type	Description
DateTime

_persistedNotCompleted

Persisted value, see property NotCompleted.

Declaration

protected uint _persistedNotCompleted

Field Value

Type	Description
UInt32

_persistedNotCompletedInPeriod

Persisted value, see property NotCompletedInPeriod.

Declaration

protected uint _persistedNotCompletedInPeriod

Field Value

Type	Description
UInt32

_persistedPersonId

Persisted value, see property PersonId.

Declaration

protected int _persistedPersonId

Field Value

Type	Description
Int32

_persistedProjectId

Persisted value, see property ProjectId.

Declaration

protected int _persistedProjectId

Field Value

Type	Description
Int32

_persistedRecordType

Persisted value, see property RecordType.

Declaration

protected short _persistedRecordType

Field Value

Type	Description
Int16

_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

_persistedSaleStatus

Persisted value, see property SaleStatus.

Declaration

protected SaleStatus _persistedSaleStatus

Field Value

Type	Description
SaleStatus

_persistedTotalReg

Persisted value, see property TotalReg.

Declaration

protected uint _persistedTotalReg

Field Value

Type	Description
UInt32

_persistedTotalRegInPeriod

Persisted value, see property TotalRegInPeriod.

Declaration

protected uint _persistedTotalRegInPeriod

Field Value

Type	Description
UInt32

_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

Properties

AmountClassId

.NET type: int. Sale amount class, for splitting sale counters by amounts

Declaration

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

ContactId

.NET type: int. Link to contact, 0 if this counter is not for contacts

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.

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.

CounterValueId

.NET type: int. Primary key

Declaration

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

CounterValueTableInfo

Get the CounterValueTableInfo object associated with the row.

Declaration

public CounterValueTableInfo CounterValueTableInfo { get; }

Property Value

Type	Description
CounterValueTableInfo

Direction

.NET type: short. Same as task.direction: Direction: 0 = none, 1 = incoming, 2 = outgoing

Declaration

public virtual short Direction { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: Enum.

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.

Extra1Count

.NET type: uint. Total registered records of this type in the second period (there are up to three period definitions)

Declaration

public virtual uint Extra1Count { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

Extra1Id

.NET type: int. Spare ID for future links

Declaration

public virtual int Extra1Id { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: Id.

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.

Extra2Count

.NET type: uint. Total records with status Not Completed in the second period (there are up to three period definitions)

Declaration

public virtual uint Extra2Count { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

Extra2Id

.NET type: int. Spare ID for future links

Declaration

public virtual int Extra2Id { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: Id.

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.

Extra3Count

.NET type: uint. Total registered records of this type in the third period (there are up to three period definitions)

Declaration

public virtual uint Extra3Count { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

Extra4Count

.NET type: uint. Total records with status Not Completed in the third period (there are up to three period definitions)

Declaration

public virtual uint Extra4Count { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

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

IntentId

.NET type: int. Link to Intent list

Declaration

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

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.

LastCompleted

.NET type: DateTime. ActiveDate/SaleDate/CreatedAt of last COMPLETED activity/sale/ticket of this type

Declaration

public virtual DateTime LastCompleted { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

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.

LastDoBy

.NET type: DateTime. ActiveDate/SaleDate/CreatedAt of last NOT COMPLETED activity/sale/ticket of this type

Declaration

public virtual DateTime LastDoBy { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

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.

LastRegistered

.NET type: DateTime. ActiveDate/SaleDate/CreatedAt of last activity/sale/ticket of this type

Declaration

public virtual DateTime LastRegistered { get; set; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

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.

NotCompleted

.NET type: uint. Total records with status Not Completed

Declaration

public virtual uint NotCompleted { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

NotCompletedInPeriod

.NET type: uint. Total records with status Not Completed in the first period (there are up to three period definitions)

Declaration

public virtual uint NotCompletedInPeriod { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

PersonId

.NET type: int. Link to person, 0 if this counter is not for person (always 0 in 6.0)

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.

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.

ProjectId

.NET type: int. Link to project, 0 if this counter is not for project

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.

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.

RecordType

.NET type: short. Same as task.record_type: 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes

Declaration

public virtual short RecordType { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: Enum.

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.

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.

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.

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.

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.

SaleStatus

.NET type: SaleStatus. Sale status: 0 = Unknown, 1 = open, 2 = closed, 3 = lost, 4 = all sales

Declaration

public virtual SaleStatus SaleStatus { get; set; }

Property Value

Type	Description
SaleStatus

Remarks

Original type in dictionary: Enum.

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.

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

TotalReg

.NET type: uint. Total registered records of this type

Declaration

public virtual uint TotalReg { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

TotalRegInPeriod

.NET type: uint. Total registered records of this type in the first period (there are up to three period definitions)

Declaration

public virtual uint TotalRegInPeriod { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

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.

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.

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.

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.

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.

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.

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.

Methods

CreateNew()

Create a new instance of the CounterValueRow object. Visible for rights

Declaration

public static CounterValueRow CreateNew()

Returns

Type	Description
CounterValueRow	A new instance of the CounterValueRow object.

GetFromCustomSearch(CounterValueRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxCounterValueId(Int32)

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

Declaration

public static CounterValueRow GetFromIdxCounterValueId(int counterValueId)

Parameters

Type	Name	Description
Int32	counterValueId

Returns

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

GetFromReader(SoDataReader, CounterValueTableInfo)

Create a new instance of the CounterValueRow 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. Visible for rights

Declaration

public static CounterValueRow GetFromReader(SoDataReader reader, CounterValueTableInfo tableInfo)

Parameters

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

_onAmountClassIdChange

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

Declaration

protected event OnFieldChange<int> _onAmountClassIdChange

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>

_onDirectionChange

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

Declaration

protected event OnFieldChange<short> _onDirectionChange

Event Type

Type	Description
OnFieldChange<Int16>

_onExtra1CountChange

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

Declaration

protected event OnFieldChange<uint> _onExtra1CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onExtra1IdChange

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

Declaration

protected event OnFieldChange<int> _onExtra1IdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onExtra2CountChange

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

Declaration

protected event OnFieldChange<uint> _onExtra2CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onExtra2IdChange

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

Declaration

protected event OnFieldChange<int> _onExtra2IdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onExtra3CountChange

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

Declaration

protected event OnFieldChange<uint> _onExtra3CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onExtra4CountChange

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

Declaration

protected event OnFieldChange<uint> _onExtra4CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onIntentIdChange

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

Declaration

protected event OnFieldChange<int> _onIntentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onLastCompletedChange

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

Declaration

protected event OnFieldChange<DateTime> _onLastCompletedChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onLastDoByChange

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

Declaration

protected event OnFieldChange<DateTime> _onLastDoByChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onLastRegisteredChange

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

Declaration

protected event OnFieldChange<DateTime> _onLastRegisteredChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onNotCompletedChange

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

Declaration

protected event OnFieldChange<uint> _onNotCompletedChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onNotCompletedInPeriodChange

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

Declaration

protected event OnFieldChange<uint> _onNotCompletedInPeriodChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onPersonIdChange

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

Declaration

protected event OnFieldChange<int> _onPersonIdChange

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>

_onRecordTypeChange

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

Declaration

protected event OnFieldChange<short> _onRecordTypeChange

Event Type

Type	Description
OnFieldChange<Int16>

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

_onSaleStatusChange

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

Declaration

protected event OnFieldChange<SaleStatus> _onSaleStatusChange

Event Type

Type	Description
OnFieldChange<SaleStatus>

_onTotalRegChange

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

Declaration

protected event OnFieldChange<uint> _onTotalRegChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onTotalRegInPeriodChange

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

Declaration

protected event OnFieldChange<uint> _onTotalRegInPeriodChange

Event Type

Type	Description
OnFieldChange<UInt32>

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

OnAmountClassIdChange

Event raised when AmountClassId is changing.

Declaration

public event OnFieldChange<int> OnAmountClassIdChange

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>

OnDirectionChange

Event raised when Direction is changing.

Declaration

public event OnFieldChange<short> OnDirectionChange

Event Type

Type	Description
OnFieldChange<Int16>

OnExtra1CountChange

Event raised when Extra1Count is changing.

Declaration

public event OnFieldChange<uint> OnExtra1CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnExtra1IdChange

Event raised when Extra1Id is changing.

Declaration

public event OnFieldChange<int> OnExtra1IdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnExtra2CountChange

Event raised when Extra2Count is changing.

Declaration

public event OnFieldChange<uint> OnExtra2CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnExtra2IdChange

Event raised when Extra2Id is changing.

Declaration

public event OnFieldChange<int> OnExtra2IdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnExtra3CountChange

Event raised when Extra3Count is changing.

Declaration

public event OnFieldChange<uint> OnExtra3CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnExtra4CountChange

Event raised when Extra4Count is changing.

Declaration

public event OnFieldChange<uint> OnExtra4CountChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnIntentIdChange

Event raised when IntentId is changing.

Declaration

public event OnFieldChange<int> OnIntentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnLastCompletedChange

Event raised when LastCompleted is changing.

Declaration

public event OnFieldChange<DateTime> OnLastCompletedChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnLastDoByChange

Event raised when LastDoBy is changing.

Declaration

public event OnFieldChange<DateTime> OnLastDoByChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnLastRegisteredChange

Event raised when LastRegistered is changing.

Declaration

public event OnFieldChange<DateTime> OnLastRegisteredChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnNotCompletedChange

Event raised when NotCompleted is changing.

Declaration

public event OnFieldChange<uint> OnNotCompletedChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnNotCompletedInPeriodChange

Event raised when NotCompletedInPeriod is changing.

Declaration

public event OnFieldChange<uint> OnNotCompletedInPeriodChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnPersonIdChange

Event raised when PersonId is changing.

Declaration

public event OnFieldChange<int> OnPersonIdChange

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>

OnRecordTypeChange

Event raised when RecordType is changing.

Declaration

public event OnFieldChange<short> OnRecordTypeChange

Event Type

Type	Description
OnFieldChange<Int16>

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>

OnSaleStatusChange

Event raised when SaleStatus is changing.

Declaration

public event OnFieldChange<SaleStatus> OnSaleStatusChange

Event Type

Type	Description
OnFieldChange<SaleStatus>

OnTotalRegChange

Event raised when TotalReg is changing.

Declaration

public event OnFieldChange<uint> OnTotalRegChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnTotalRegInPeriodChange

Event raised when TotalRegInPeriod is changing.

Declaration

public event OnFieldChange<uint> OnTotalRegInPeriodChange

Event Type

Type	Description
OnFieldChange<UInt32>

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>

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)