Class ReplyTemplateBodyRow

Contains the body of the reply templates in different languages
Row Object for table 'reply_template_body'. 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

ReplyTemplateBodyRow

Implements

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

Unique indexes on table ReplyTemplateBody are:

Index fields	Nested index class name

Constructors

ReplyTemplateBodyRow(ReplyTemplateBodyRow.ReplyTemplateBodyRowIdxBase)

Constructor for the class taking an index as argument. Contains the body of the reply templates in different languages

Declaration

protected ReplyTemplateBodyRow(ReplyTemplateBodyRow.ReplyTemplateBodyRowIdxBase idx)

Parameters

Type	Name	Description
ReplyTemplateBodyRow.ReplyTemplateBodyRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentBodyHtml

Current value, see property BodyHtml.

Declaration

protected string _currentBodyHtml

Field Value

Type	Description
String

_currentBodyPlain

Current value, see property BodyPlain.

Declaration

protected string _currentBodyPlain

Field Value

Type	Description
String

_currentBodySms

Current value, see property BodySms.

Declaration

protected string _currentBodySms

Field Value

Type	Description
String

_currentFlags

Current value, see property Flags.

Declaration

protected int _currentFlags

Field Value

Type	Description
Int32

_currentHeaders

Current value, see property Headers.

Declaration

protected string _currentHeaders

Field Value

Type	Description
String

_currentLanguageId

Current value, see property LanguageId.

Declaration

protected int _currentLanguageId

Field Value

Type	Description
Int32

_currentReplyTemplateBodyId

Current value, see property ReplyTemplateBodyId.

Declaration

protected int _currentReplyTemplateBodyId

Field Value

Type	Description
Int32

_currentReplyTemplateId

Current value, see property ReplyTemplateId.

Declaration

protected int _currentReplyTemplateId

Field Value

Type	Description
Int32

_currentSubject

Current value, see property Subject.

Declaration

protected string _currentSubject

Field Value

Type	Description
String

_persistedBodyHtml

Persisted value, see property BodyHtml.

Declaration

protected string _persistedBodyHtml

Field Value

Type	Description
String

_persistedBodyPlain

Persisted value, see property BodyPlain.

Declaration

protected string _persistedBodyPlain

Field Value

Type	Description
String

_persistedBodySms

Persisted value, see property BodySms.

Declaration

protected string _persistedBodySms

Field Value

Type	Description
String

_persistedFlags

Persisted value, see property Flags.

Declaration

protected int _persistedFlags

Field Value

Type	Description
Int32

_persistedHeaders

Persisted value, see property Headers.

Declaration

protected string _persistedHeaders

Field Value

Type	Description
String

_persistedLanguageId

Persisted value, see property LanguageId.

Declaration

protected int _persistedLanguageId

Field Value

Type	Description
Int32

_persistedReplyTemplateBodyId

Persisted value, see property ReplyTemplateBodyId.

Declaration

protected int _persistedReplyTemplateBodyId

Field Value

Type	Description
Int32

_persistedReplyTemplateId

Persisted value, see property ReplyTemplateId.

Declaration

protected int _persistedReplyTemplateId

Field Value

Type	Description
Int32

_persistedSubject

Persisted value, see property Subject.

Declaration

protected string _persistedSubject

Field Value

Type	Description
String

Properties

BodyHtml

.NET type: string. The html version of the body.

Declaration

public virtual string BodyHtml { get; set; }

Property Value

Type	Description
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

BodyPlain

.NET type: string. The plain text version of the body.

Declaration

public virtual string BodyPlain { get; set; }

Property Value

Type	Description
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

BodySms

.NET type: string. The sms version of the body.

Declaration

public virtual string BodySms { get; set; }

Property Value

Type	Description
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

Flags

.NET type: int. Identifies the status of the template body. Default, not default etc.

Declaration

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

Headers

.NET type: string. Additional headers. Optional

Declaration

public virtual string Headers { get; set; }

Property Value

Type	Description
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

PrivateSave.InnerFieldValuePairs

InnerPrimaryKey

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

Declaration

protected override FieldInfo InnerPrimaryKey { get; }

Property Value

Type	Description
FieldInfo

Overrides

PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration

protected override Parameter InnerPrimaryKeyValue { get; }

Property Value

Type	Description
Parameter

Overrides

PrivateSave.InnerPrimaryKeyValue

IsDirty

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

Declaration

public override bool IsDirty { get; }

Property Value

Type	Description
Boolean

Overrides

TableRowBase.IsDirty

IsNew

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

Declaration

public override bool IsNew { get; }

Property Value

Type	Description
Boolean

Overrides

TableRowBase.IsNew

Item[String]

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

Declaration

public override object this[string fieldName] { get; set; }

Parameters

Type	Name	Description
String	fieldName	Name of the field in the database

Property Value

Type	Description
Object	Value of the field.

Overrides

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

LanguageId

.NET type: int. Links the body to a reply template

Declaration

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

ReplyTemplateBodyId

.NET type: int. The primary key (auto-incremented)

Declaration

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

ReplyTemplateBodyTableInfo

Get the ReplyTemplateBodyTableInfo object associated with the row.

Declaration

public ReplyTemplateBodyTableInfo ReplyTemplateBodyTableInfo { get; }

Property Value

Type	Description
ReplyTemplateBodyTableInfo

ReplyTemplateId

.NET type: int. Links the body to a reply template

Declaration

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

Subject

.NET type: string. Subject of the outgoing message. Ignored if not needed

Declaration

public virtual string Subject { get; set; }

Property Value

Type	Description
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

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

Methods

CreateNew()

Create a new instance of the ReplyTemplateBodyRow object. Contains the body of the reply templates in different languages

Declaration

public static ReplyTemplateBodyRow CreateNew()

Returns

Type	Description
ReplyTemplateBodyRow	A new instance of the ReplyTemplateBodyRow object.

GetFromCustomSearch(ReplyTemplateBodyRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxReplyTemplateBodyId(Int32)

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

Declaration

public static ReplyTemplateBodyRow GetFromIdxReplyTemplateBodyId(int replyTemplateBodyId)

Parameters

Type	Name	Description
Int32	replyTemplateBodyId

Returns

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

GetFromReader(SoDataReader, ReplyTemplateBodyTableInfo)

Create a new instance of the ReplyTemplateBodyRow 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. Contains the body of the reply templates in different languages

Declaration

public static ReplyTemplateBodyRow GetFromReader(SoDataReader reader, ReplyTemplateBodyTableInfo tableInfo)

Parameters

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

_onBodyHtmlChange

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

Declaration

protected event OnFieldChange<string> _onBodyHtmlChange

Event Type

Type	Description
OnFieldChange<String>

_onBodyPlainChange

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

Declaration

protected event OnFieldChange<string> _onBodyPlainChange

Event Type

Type	Description
OnFieldChange<String>

_onBodySmsChange

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

Declaration

protected event OnFieldChange<string> _onBodySmsChange

Event Type

Type	Description
OnFieldChange<String>

_onFlagsChange

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

Declaration

protected event OnFieldChange<int> _onFlagsChange

Event Type

Type	Description
OnFieldChange<Int32>

_onHeadersChange

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

Declaration

protected event OnFieldChange<string> _onHeadersChange

Event Type

Type	Description
OnFieldChange<String>

_onLanguageIdChange

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

Declaration

protected event OnFieldChange<int> _onLanguageIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onReplyTemplateIdChange

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

Declaration

protected event OnFieldChange<int> _onReplyTemplateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onSubjectChange

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

Declaration

protected event OnFieldChange<string> _onSubjectChange

Event Type

Type	Description
OnFieldChange<String>

OnBodyHtmlChange

Event raised when BodyHtml is changing.

Declaration

public event OnFieldChange<string> OnBodyHtmlChange

Event Type

Type	Description
OnFieldChange<String>

OnBodyPlainChange

Event raised when BodyPlain is changing.

Declaration

public event OnFieldChange<string> OnBodyPlainChange

Event Type

Type	Description
OnFieldChange<String>

OnBodySmsChange

Event raised when BodySms is changing.

Declaration

public event OnFieldChange<string> OnBodySmsChange

Event Type

Type	Description
OnFieldChange<String>

OnFlagsChange

Event raised when Flags is changing.

Declaration

public event OnFieldChange<int> OnFlagsChange

Event Type

Type	Description
OnFieldChange<Int32>

OnHeadersChange

Event raised when Headers is changing.

Declaration

public event OnFieldChange<string> OnHeadersChange

Event Type

Type	Description
OnFieldChange<String>

OnLanguageIdChange

Event raised when LanguageId is changing.

Declaration

public event OnFieldChange<int> OnLanguageIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnReplyTemplateIdChange

Event raised when ReplyTemplateId is changing.

Declaration

public event OnFieldChange<int> OnReplyTemplateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnSubjectChange

Event raised when Subject is changing.

Declaration

public event OnFieldChange<string> OnSubjectChange

Event Type

Type	Description
OnFieldChange<String>

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)