Class EmailRow

Email addresses for contacts, projects and persons
Row Object for table 'Email'. 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
EmailRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class EmailRow : 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) EmailRow EmailRow.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(EmailRow.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 EmailTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, EmailTableInfo) 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 EmailRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, EmailTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Email are:

Index fieldsNested index class name

Constructors

EmailRow(EmailRow.EmailRowIdxBase)

Constructor for the class taking an index as argument. Email addresses for contacts, projects and persons

Declaration
protected EmailRow(EmailRow.EmailRowIdxBase idx)
Parameters
Type Name Description
EmailRow.EmailRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAppointmentId

Current value, see property AppointmentId.

Declaration
protected int _currentAppointmentId
Field Value
Type Description
Int32

_currentBounceCount

Current value, see property BounceCount.

Declaration
protected short _currentBounceCount
Field Value
Type Description
Int16

_currentContactId

Current value, see property ContactId.

Declaration
protected int _currentContactId
Field Value
Type Description
Int32

_currentDbiAgentId

Current value, see property DbiAgentId.

Declaration
protected int _currentDbiAgentId
Field Value
Type Description
Int32

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentEmailAddress

Current value, see property EmailAddress.

Declaration
protected string _currentEmailAddress
Field Value
Type Description
String

_currentEmailId

Current value, see property EmailId.

Declaration
protected int _currentEmailId
Field Value
Type Description
Int32

_currentLastBounce

Current value, see property LastBounce.

Declaration
protected DateTime _currentLastBounce
Field Value
Type Description
DateTime

_currentLastBounceCode

Current value, see property LastBounceCode.

Declaration
protected int _currentLastBounceCode
Field Value
Type Description
Int32

_currentLastBounceReason

Current value, see property LastBounceReason.

Declaration
protected string _currentLastBounceReason
Field Value
Type Description
String

_currentLastSent

Current value, see property LastSent.

Declaration
protected DateTime _currentLastSent
Field Value
Type Description
DateTime

_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

_currentProtocol

Current value, see property Protocol.

Declaration
protected string _currentProtocol
Field Value
Type Description
String

_currentRank

Current value, see property Rank.

Declaration
protected short _currentRank
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

_currentReservedId1

Current value, see property ReservedId1.

Declaration
protected int _currentReservedId1
Field Value
Type Description
Int32

_currentReservedId2

Current value, see property ReservedId2.

Declaration
protected int _currentReservedId2
Field Value
Type Description
Int32

_currentType

Current value, see property Type.

Declaration
protected EmailType _currentType
Field Value
Type Description
EmailType

_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

_persistedAppointmentId

Persisted value, see property AppointmentId.

Declaration
protected int _persistedAppointmentId
Field Value
Type Description
Int32

_persistedBounceCount

Persisted value, see property BounceCount.

Declaration
protected short _persistedBounceCount
Field Value
Type Description
Int16

_persistedContactId

Persisted value, see property ContactId.

Declaration
protected int _persistedContactId
Field Value
Type Description
Int32

_persistedDbiAgentId

Persisted value, see property DbiAgentId.

Declaration
protected int _persistedDbiAgentId
Field Value
Type Description
Int32

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedEmailAddress

Persisted value, see property EmailAddress.

Declaration
protected string _persistedEmailAddress
Field Value
Type Description
String

_persistedEmailId

Persisted value, see property EmailId.

Declaration
protected int _persistedEmailId
Field Value
Type Description
Int32

_persistedLastBounce

Persisted value, see property LastBounce.

Declaration
protected DateTime _persistedLastBounce
Field Value
Type Description
DateTime

_persistedLastBounceCode

Persisted value, see property LastBounceCode.

Declaration
protected int _persistedLastBounceCode
Field Value
Type Description
Int32

_persistedLastBounceReason

Persisted value, see property LastBounceReason.

Declaration
protected string _persistedLastBounceReason
Field Value
Type Description
String

_persistedLastSent

Persisted value, see property LastSent.

Declaration
protected DateTime _persistedLastSent
Field Value
Type Description
DateTime

_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

_persistedProtocol

Persisted value, see property Protocol.

Declaration
protected string _persistedProtocol
Field Value
Type Description
String

_persistedRank

Persisted value, see property Rank.

Declaration
protected short _persistedRank
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

_persistedReservedId1

Persisted value, see property ReservedId1.

Declaration
protected int _persistedReservedId1
Field Value
Type Description
Int32

_persistedReservedId2

Persisted value, see property ReservedId2.

Declaration
protected int _persistedReservedId2
Field Value
Type Description
Int32

_persistedType

Persisted value, see property Type.

Declaration
protected EmailType _persistedType
Field Value
Type Description
EmailType

_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

AppointmentId

.NET type: int. The id of the invitation appointment record, used when unknown person is associated with an appointment invitation

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

Original type in dictionary: FK.

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

BounceCount

.NET type: short. Number of bounces detected

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

Original type in dictionary: UShort.

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

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

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

Exceptions
Type Condition
SoSentryException

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

ContactId

.NET type: int. Relations to possible owners

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

Original type in dictionary: FK.

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

DbiAgentId

.NET type: int. Integration agent (eJournal)

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

Original type in dictionary: FK.

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

Description

.NET type: string. Visible field

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

Original type in dictionary: String[255].

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

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

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

Exceptions
Type Condition
SoSentryException

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

EmailAddress

.NET type: string. The address itself

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

Original type in dictionary: String[240].

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

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

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

Exceptions
Type Condition
SoSentryException

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

EmailId

.NET type: int. Primary key

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

Original type in dictionary: PK.

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

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

EmailTableInfo

Get the EmailTableInfo object associated with the row.

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

InnerFieldValuePairs

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

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

InnerPrimaryKey

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

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

InnerPrimaryKeyValue

The actual value the primary key must have.

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

IsDirty

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

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

IsNew

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

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

Item[String]

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

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

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

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

LastBounce

.NET type: DateTime. When did last bounce happen

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

Original type in dictionary: DateTime.

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

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

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

Exceptions
Type Condition
SoSentryException

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

LastBounceCode

.NET type: int. If this email address has bounced and we have a bounce code, this field will contain the code for the last bounce

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

Original type in dictionary: Int.

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

LastBounceReason

.NET type: string. If this email address has bounced and we have a bounce reason, this field will contain the reason for the last bounce

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

Original type in dictionary: String[4001].

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

LastSent

.NET type: DateTime. Last transmission (regardless of success/bounce)

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

Original type in dictionary: DateTime.

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

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

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

Exceptions
Type Condition
SoSentryException

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

PersonId

.NET type: int. Relations to possible owners

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

Original type in dictionary: FK.

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

ProjectId

.NET type: int. Relations to possible owners

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

Original type in dictionary: FK.

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

Protocol

.NET type: string. SMTP, MSN, Skype, etc

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

Original type in dictionary: String[12].

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

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

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

Exceptions
Type Condition
SoSentryException

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

Rank

.NET type: short. Rank order in lists

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

Original type in dictionary: UShort.

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

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

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

Exceptions
Type Condition
SoSentryException

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

Registered

.NET type: DateTime. Registered when in UTC

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

Original type in dictionary: UtcDateTime.

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

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

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

Exceptions
Type Condition
SoSentryException

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

RegisteredAssociateId

.NET type: int. Registered by whom

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

Original type in dictionary: FK.

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

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

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

Exceptions
Type Condition
SoSentryException

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

ReservedId1

.NET type: int. Reserved for potential future owners

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

Original type in dictionary: Id.

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

ReservedId2

.NET type: int. Reserved for potential future owners

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

Original type in dictionary: Id.

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

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

Type

.NET type: EmailType. 0 = email, 1 = chat/instant msg, 2 = voip; see protocol field for more info

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

Original type in dictionary: Enum.

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

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

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

Exceptions
Type Condition
SoSentryException

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

Updated

.NET type: DateTime. Last updated when in UTC

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

Original type in dictionary: UtcDateTime.

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

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

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

Exceptions
Type Condition
SoSentryException

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

UpdatedAssociateId

.NET type: int. Last updated by whom

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

Original type in dictionary: FK.

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

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

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

Exceptions
Type Condition
SoSentryException

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

UpdatedCount

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

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

Original type in dictionary: UShort.

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

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

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

Exceptions
Type Condition
SoSentryException

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

Methods

CreateNew()

Create a new instance of the EmailRow object. Email addresses for contacts, projects and persons

Declaration
public static EmailRow CreateNew()
Returns
Type Description
EmailRow

A new instance of the EmailRow object.

GetFromCustomSearch(EmailRow.CustomSearch)

Create a new instance of the EmailRow 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 EmailRow GetFromCustomSearch(EmailRow.CustomSearch query)
Parameters
Type Name Description
EmailRow.CustomSearch query

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

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

GetFromIdxEmailId(Int32)

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

Declaration
public static EmailRow GetFromIdxEmailId(int emailId)
Parameters
Type Name Description
Int32 emailId
Returns
Type Description
EmailRow

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

GetFromReader(SoDataReader, EmailTableInfo)

Create a new instance of the EmailRow 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. Email addresses for contacts, projects and persons

Declaration
public static EmailRow GetFromReader(SoDataReader reader, EmailTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
EmailTableInfo tableInfo

EmailTableInfo 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
EmailRow

A new instance of the EmailRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

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

Specification of a field
Returns
Type Description
Object

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

Thrown if the field is not known.

InternalSetValue(String, Object)

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

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

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

Specification of a field
Returns
Type Description
Boolean

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

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

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

Object holding the data returned from the database.
TableInfo tableInfo

The TableInfo used for the SELECT statement.
Overrides

OnSave(BatchSave)

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

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

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

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

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

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

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
Remarks

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

SetDefaults(DefaulterStrategy)

Set default values for the row.

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

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

SetPrimaryKey(Int32)

Set the primary key for the row.

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

The new primary key for the row.
Overrides

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

ToString()

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

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

Validate(RowValidator)

Validate this row.

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

RowValidator for inserting the result of the validation
Overrides

Events

_onAppointmentIdChange

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

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

_onBounceCountChange

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

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

_onContactIdChange

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

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

_onDbiAgentIdChange

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

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

_onDescriptionChange

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

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

_onEmailAddressChange

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

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

_onLastBounceChange

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

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

_onLastBounceCodeChange

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

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

_onLastBounceReasonChange

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

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

_onLastSentChange

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

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

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

_onProtocolChange

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

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

_onRankChange

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

Declaration
protected event OnFieldChange<short> _onRankChange
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>

_onReservedId1Change

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

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

_onReservedId2Change

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

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

_onTypeChange

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

Declaration
protected event OnFieldChange<EmailType> _onTypeChange
Event Type
Type Description
OnFieldChange<EmailType>

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

OnAppointmentIdChange

Event raised when AppointmentId is changing.

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

OnBounceCountChange

Event raised when BounceCount is changing.

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

OnContactIdChange

Event raised when ContactId is changing.

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

OnDbiAgentIdChange

Event raised when DbiAgentId is changing.

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

OnDescriptionChange

Event raised when Description is changing.

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

OnEmailAddressChange

Event raised when EmailAddress is changing.

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

OnLastBounceChange

Event raised when LastBounce is changing.

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

OnLastBounceCodeChange

Event raised when LastBounceCode is changing.

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

OnLastBounceReasonChange

Event raised when LastBounceReason is changing.

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

OnLastSentChange

Event raised when LastSent is changing.

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

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>

OnProtocolChange

Event raised when Protocol is changing.

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

OnRankChange

Event raised when Rank is changing.

Declaration
public event OnFieldChange<short> OnRankChange
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>

OnReservedId1Change

Event raised when ReservedId1 is changing.

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

OnReservedId2Change

Event raised when ReservedId2 is changing.

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

OnTypeChange

Event raised when Type is changing.

Declaration
public event OnFieldChange<EmailType> OnTypeChange
Event Type
Type Description
OnFieldChange<EmailType>

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)