Class EmailItemRow

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

Unique indexes on table EmailItem are:

Index fieldsNested index class name

Constructors

EmailItemRow(EmailItemRow.EmailItemRowIdxBase)

Constructor for the class taking an index as argument. Email data

Declaration
protected EmailItemRow(EmailItemRow.EmailItemRowIdxBase idx)
Parameters
Type Name Description
SuperOffice.CRM.Rows.EmailItemRow.EmailItemRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAccountId

Current value, see property AccountId.

Declaration
protected int _currentAccountId
Field Value
Type Description
System.Int32

_currentAppointmentId

Current value, see property AppointmentId.

Declaration
protected int _currentAppointmentId
Field Value
Type Description
System.Int32

_currentCalData

Current value, see property CalData.

Declaration
protected string _currentCalData
Field Value
Type Description
System.String

_currentCc

Current value, see property Cc.

Declaration
protected string _currentCc
Field Value
Type Description
System.String

_currentContactId

Current value, see property ContactId.

Declaration
protected int _currentContactId
Field Value
Type Description
System.Int32

_currentDocumentId

Current value, see property DocumentId.

Declaration
protected int _currentDocumentId
Field Value
Type Description
System.Int32

_currentEmailFolderId

Current value, see property EmailFolderId.

Declaration
protected int _currentEmailFolderId
Field Value
Type Description
System.Int32

_currentEmailItemId

Current value, see property EmailItemId.

Declaration
protected int _currentEmailItemId
Field Value
Type Description
System.Int32

_currentFlags

Current value, see property Flags.

Declaration
protected EMailFlags _currentFlags
Field Value
Type Description
EMailFlags

_currentFrom

Current value, see property From.

Declaration
protected string _currentFrom
Field Value
Type Description
System.String

_currentHasAttachment

Current value, see property HasAttachment.

Declaration
protected short _currentHasAttachment
Field Value
Type Description
System.Int16

_currentHtmlBody

Current value, see property HtmlBody.

Declaration
protected string _currentHtmlBody
Field Value
Type Description
System.String

_currentInReplyTo

Current value, see property InReplyTo.

Declaration
protected string _currentInReplyTo
Field Value
Type Description
System.String

_currentMessageId

Current value, see property MessageId.

Declaration
protected string _currentMessageId
Field Value
Type Description
System.String

_currentMime

Current value, see property Mime.

Declaration
protected string _currentMime
Field Value
Type Description
System.String

_currentPersonId

Current value, see property PersonId.

Declaration
protected int _currentPersonId
Field Value
Type Description
System.Int32

_currentPlainBody

Current value, see property PlainBody.

Declaration
protected string _currentPlainBody
Field Value
Type Description
System.String

_currentPriority

Current value, see property Priority.

Declaration
protected EMailPriority _currentPriority
Field Value
Type Description
EMailPriority

_currentReceivedAt

Current value, see property ReceivedAt.

Declaration
protected DateTime _currentReceivedAt
Field Value
Type Description
System.DateTime

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
System.DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
System.Int32

_currentRepliedAt

Current value, see property RepliedAt.

Declaration
protected DateTime _currentRepliedAt
Field Value
Type Description
System.DateTime

_currentSaleId

Current value, see property SaleId.

Declaration
protected int _currentSaleId
Field Value
Type Description
System.Int32

_currentSentAt

Current value, see property SentAt.

Declaration
protected DateTime _currentSentAt
Field Value
Type Description
System.DateTime

_currentServerId

Current value, see property ServerId.

Declaration
protected int _currentServerId
Field Value
Type Description
System.Int32

_currentSize

Current value, see property Size.

Declaration
protected int _currentSize
Field Value
Type Description
System.Int32

_currentSubject

Current value, see property Subject.

Declaration
protected string _currentSubject
Field Value
Type Description
System.String

_currentTo

Current value, see property To.

Declaration
protected string _currentTo
Field Value
Type Description
System.String

_currentUpdated

Current value, see property Updated.

Declaration
protected DateTime _currentUpdated
Field Value
Type Description
System.DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration
protected int _currentUpdatedAssociateId
Field Value
Type Description
System.Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration
protected short _currentUpdatedCount
Field Value
Type Description
System.Int16

_persistedAccountId

Persisted value, see property AccountId.

Declaration
protected int _persistedAccountId
Field Value
Type Description
System.Int32

_persistedAppointmentId

Persisted value, see property AppointmentId.

Declaration
protected int _persistedAppointmentId
Field Value
Type Description
System.Int32

_persistedCalData

Persisted value, see property CalData.

Declaration
protected string _persistedCalData
Field Value
Type Description
System.String

_persistedCc

Persisted value, see property Cc.

Declaration
protected string _persistedCc
Field Value
Type Description
System.String

_persistedContactId

Persisted value, see property ContactId.

Declaration
protected int _persistedContactId
Field Value
Type Description
System.Int32

_persistedDocumentId

Persisted value, see property DocumentId.

Declaration
protected int _persistedDocumentId
Field Value
Type Description
System.Int32

_persistedEmailFolderId

Persisted value, see property EmailFolderId.

Declaration
protected int _persistedEmailFolderId
Field Value
Type Description
System.Int32

_persistedEmailItemId

Persisted value, see property EmailItemId.

Declaration
protected int _persistedEmailItemId
Field Value
Type Description
System.Int32

_persistedFlags

Persisted value, see property Flags.

Declaration
protected EMailFlags _persistedFlags
Field Value
Type Description
EMailFlags

_persistedFrom

Persisted value, see property From.

Declaration
protected string _persistedFrom
Field Value
Type Description
System.String

_persistedHasAttachment

Persisted value, see property HasAttachment.

Declaration
protected short _persistedHasAttachment
Field Value
Type Description
System.Int16

_persistedHtmlBody

Persisted value, see property HtmlBody.

Declaration
protected string _persistedHtmlBody
Field Value
Type Description
System.String

_persistedInReplyTo

Persisted value, see property InReplyTo.

Declaration
protected string _persistedInReplyTo
Field Value
Type Description
System.String

_persistedMessageId

Persisted value, see property MessageId.

Declaration
protected string _persistedMessageId
Field Value
Type Description
System.String

_persistedMime

Persisted value, see property Mime.

Declaration
protected string _persistedMime
Field Value
Type Description
System.String

_persistedPersonId

Persisted value, see property PersonId.

Declaration
protected int _persistedPersonId
Field Value
Type Description
System.Int32

_persistedPlainBody

Persisted value, see property PlainBody.

Declaration
protected string _persistedPlainBody
Field Value
Type Description
System.String

_persistedPriority

Persisted value, see property Priority.

Declaration
protected EMailPriority _persistedPriority
Field Value
Type Description
EMailPriority

_persistedReceivedAt

Persisted value, see property ReceivedAt.

Declaration
protected DateTime _persistedReceivedAt
Field Value
Type Description
System.DateTime

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
System.DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
System.Int32

_persistedRepliedAt

Persisted value, see property RepliedAt.

Declaration
protected DateTime _persistedRepliedAt
Field Value
Type Description
System.DateTime

_persistedSaleId

Persisted value, see property SaleId.

Declaration
protected int _persistedSaleId
Field Value
Type Description
System.Int32

_persistedSentAt

Persisted value, see property SentAt.

Declaration
protected DateTime _persistedSentAt
Field Value
Type Description
System.DateTime

_persistedServerId

Persisted value, see property ServerId.

Declaration
protected int _persistedServerId
Field Value
Type Description
System.Int32

_persistedSize

Persisted value, see property Size.

Declaration
protected int _persistedSize
Field Value
Type Description
System.Int32

_persistedSubject

Persisted value, see property Subject.

Declaration
protected string _persistedSubject
Field Value
Type Description
System.String

_persistedTo

Persisted value, see property To.

Declaration
protected string _persistedTo
Field Value
Type Description
System.String

_persistedUpdated

Persisted value, see property Updated.

Declaration
protected DateTime _persistedUpdated
Field Value
Type Description
System.DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type Description
System.Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration
protected short _persistedUpdatedCount
Field Value
Type Description
System.Int16

Properties

AccountId

.NET type: int. Account id

Declaration
public virtual int AccountId { get; set; }
Property Value
Type Description
System.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

AppointmentId

.NET type: int. Archived on appointment

Declaration
public virtual int AppointmentId { get; set; }
Property Value
Type Description
System.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

CalData

.NET type: string. Calendar data

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

Original type in dictionary: Clob.

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

Cc

.NET type: string. Cc

Declaration
public virtual string Cc { get; set; }
Property Value
Type Description
System.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

ContactId

.NET type: int. From company

Declaration
public virtual int ContactId { get; set; }
Property Value
Type Description
System.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

DocumentId

.NET type: int. Archived document

Declaration
public virtual int DocumentId { get; set; }
Property Value
Type Description
System.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

EmailFolderId

.NET type: int. Folder this email is in on the imap server

Declaration
public virtual int EmailFolderId { get; set; }
Property Value
Type Description
System.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

EmailItemId

.NET type: int. Primary key

Declaration
public virtual int EmailItemId { get; }
Property Value
Type Description
System.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

EmailItemTableInfo

Get the EmailItemTableInfo object associated with the row.

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

Flags

.NET type: EMailFlags. Email flags - answered, deleted, seen, flagged, draft, recent...

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

Original type in dictionary: Enum.

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

From

.NET type: string. From address

Declaration
public virtual string From { get; set; }
Property Value
Type Description
System.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

HasAttachment

.NET type: short. Has attachment(s)

Declaration
public virtual short HasAttachment { get; set; }
Property Value
Type Description
System.Int16
Remarks

Original type in dictionary: Bool.

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

HtmlBody

.NET type: string. Html body text

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

Original type in dictionary: Clob.

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

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

InReplyTo

.NET type: string. In reply to, a message-id, used for threading

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

Original type in dictionary: String[513].

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

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
System.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
System.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
System.String fieldName

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

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

MessageId

.NET type: string. Email MessageId

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

Original type in dictionary: String[513].

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

Mime

.NET type: string. Mime text

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

Original type in dictionary: Clob.

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

PersonId

.NET type: int. From person

Declaration
public virtual int PersonId { get; set; }
Property Value
Type Description
System.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

PlainBody

.NET type: string. Plain body text

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

Original type in dictionary: Clob.

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

Priority

.NET type: EMailPriority. Email priority

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

Original type in dictionary: Enum.

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

ReceivedAt

.NET type: DateTime. Received by email server

Declaration
public virtual DateTime ReceivedAt { get; set; }
Property Value
Type Description
System.DateTime
Remarks

Original type in dictionary: DateTime.

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

Registered

.NET type: DateTime. Registered when in UTC

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

Original type in dictionary: UtcDateTime.

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

RegisteredAssociateId

.NET type: int. Registered by whom

Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
System.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

RepliedAt

.NET type: DateTime. When this email was replied to

Declaration
public virtual DateTime RepliedAt { get; set; }
Property Value
Type Description
System.DateTime
Remarks

Original type in dictionary: DateTime.

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

SaleId

.NET type: int. Archived on sale

Declaration
public virtual int SaleId { get; set; }
Property Value
Type Description
System.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

SentAt

.NET type: DateTime. Sent datetime from mime

Declaration
public virtual DateTime SentAt { get; set; }
Property Value
Type Description
System.DateTime
Remarks

Original type in dictionary: DateTime.

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

ServerId

.NET type: int. Email server id of this email item

Declaration
public virtual int ServerId { get; set; }
Property Value
Type Description
System.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

Size

.NET type: int. The size of the email

Declaration
public virtual int Size { get; set; }
Property Value
Type Description
System.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

Subject

.NET type: string. Email subject

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

Original type in dictionary: String[256].

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

To

.NET type: string. To

Declaration
public virtual string To { get; set; }
Property Value
Type Description
System.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

Updated

.NET type: DateTime. Last updated when in UTC

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

Original type in dictionary: UtcDateTime.

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

UpdatedAssociateId

.NET type: int. Last updated by whom

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
System.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

UpdatedCount

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

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

Original type in dictionary: UShort.

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

Methods

CreateNew()

Create a new instance of the EmailItemRow object. Email data

Declaration
public static EmailItemRow CreateNew()
Returns
Type Description
EmailItemRow

A new instance of the EmailItemRow object.

GetFromCustomSearch(EmailItemRow.CustomSearch)

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

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

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

GetFromIdxEmailItemId(Int32)

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

Declaration
public static EmailItemRow GetFromIdxEmailItemId(int emailItemId)
Parameters
Type Name Description
System.Int32 emailItemId
Returns
Type Description
EmailItemRow

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

GetFromReader(SoDataReader, EmailItemTableInfo)

Create a new instance of the EmailItemRow 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 data

Declaration
public static EmailItemRow GetFromReader(SoDataReader reader, EmailItemTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
EmailItemTableInfo tableInfo

EmailItemTableInfo 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
EmailItemRow

A new instance of the EmailItemRow 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
System.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
System.String fieldName
System.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
System.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
System.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
System.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
System.String

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)