Class ExtraTablesEntryRow

Hits/entries in result set of executed search in ejournal extra tables
Row Object for table 'extra_tables_entry'. 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

ExtraTablesEntryRow

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

Unique indexes on table ExtraTablesEntry are:

Index fields	Nested index class name

Constructors

ExtraTablesEntryRow(ExtraTablesEntryRow.ExtraTablesEntryRowIdxBase)

Constructor for the class taking an index as argument. Hits/entries in result set of executed search in ejournal extra tables

Declaration

protected ExtraTablesEntryRow(ExtraTablesEntryRow.ExtraTablesEntryRowIdxBase idx)

Parameters

Type	Name	Description
ExtraTablesEntryRow.ExtraTablesEntryRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentEntryId

Current value, see property EntryId.

Declaration

protected int _currentEntryId

Field Value

Type	Description
Int32

_currentExtraTablesEntryId

Current value, see property ExtraTablesEntryId.

Declaration

protected int _currentExtraTablesEntryId

Field Value

Type	Description
Int32

_currentExtraTablesResult

Current value, see property ExtraTablesResult.

Declaration

protected int _currentExtraTablesResult

Field Value

Type	Description
Int32

_currentNextId

Current value, see property NextId.

Declaration

protected int _currentNextId

Field Value

Type	Description
Int32

_currentOrderPos

Current value, see property OrderPos.

Declaration

protected int _currentOrderPos

Field Value

Type	Description
Int32

_currentPageNum

Current value, see property PageNum.

Declaration

protected int _currentPageNum

Field Value

Type	Description
Int32

_currentPrevId

Current value, see property PrevId.

Declaration

protected int _currentPrevId

Field Value

Type	Description
Int32

_persistedEntryId

Persisted value, see property EntryId.

Declaration

protected int _persistedEntryId

Field Value

Type	Description
Int32

_persistedExtraTablesEntryId

Persisted value, see property ExtraTablesEntryId.

Declaration

protected int _persistedExtraTablesEntryId

Field Value

Type	Description
Int32

_persistedExtraTablesResult

Persisted value, see property ExtraTablesResult.

Declaration

protected int _persistedExtraTablesResult

Field Value

Type	Description
Int32

_persistedNextId

Persisted value, see property NextId.

Declaration

protected int _persistedNextId

Field Value

Type	Description
Int32

_persistedOrderPos

Persisted value, see property OrderPos.

Declaration

protected int _persistedOrderPos

Field Value

Type	Description
Int32

_persistedPageNum

Persisted value, see property PageNum.

Declaration

protected int _persistedPageNum

Field Value

Type	Description
Int32

_persistedPrevId

Persisted value, see property PrevId.

Declaration

protected int _persistedPrevId

Field Value

Type	Description
Int32

Properties

EntryId

.NET type: int. The id of the entry in the extra table.

Declaration

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

ExtraTablesEntryId

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

Declaration

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

ExtraTablesEntryTableInfo

Get the ExtraTablesEntryTableInfo object associated with the row.

Declaration

public ExtraTablesEntryTableInfo ExtraTablesEntryTableInfo { get; }

Property Value

Type	Description
ExtraTablesEntryTableInfo

ExtraTablesResult

.NET type: int. The id of the result.

Declaration

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

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.

NextId

.NET type: int. The id of the entry in the extra table.

Declaration

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

OrderPos

.NET type: int. Used to order elements when listed.

Declaration

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

PageNum

.NET type: int. The pagenum of this result entry in the table.

Declaration

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

PrevId

.NET type: int. The id of the entry in the extra table.

Declaration

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

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 ExtraTablesEntryRow object. Hits/entries in result set of executed search in ejournal extra tables

Declaration

public static ExtraTablesEntryRow CreateNew()

Returns

Type	Description
ExtraTablesEntryRow	A new instance of the ExtraTablesEntryRow object.

GetFromCustomSearch(ExtraTablesEntryRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxExtraTablesEntryId(Int32)

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

Declaration

public static ExtraTablesEntryRow GetFromIdxExtraTablesEntryId(int extraTablesEntryId)

Parameters

Type	Name	Description
Int32	extraTablesEntryId

Returns

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

GetFromReader(SoDataReader, ExtraTablesEntryTableInfo)

Create a new instance of the ExtraTablesEntryRow 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. Hits/entries in result set of executed search in ejournal extra tables

Declaration

public static ExtraTablesEntryRow GetFromReader(SoDataReader reader, ExtraTablesEntryTableInfo tableInfo)

Parameters

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

_onEntryIdChange

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

Declaration

protected event OnFieldChange<int> _onEntryIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onExtraTablesResultChange

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

Declaration

protected event OnFieldChange<int> _onExtraTablesResultChange

Event Type

Type	Description
OnFieldChange<Int32>

_onNextIdChange

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

Declaration

protected event OnFieldChange<int> _onNextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onOrderPosChange

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

Declaration

protected event OnFieldChange<int> _onOrderPosChange

Event Type

Type	Description
OnFieldChange<Int32>

_onPageNumChange

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

Declaration

protected event OnFieldChange<int> _onPageNumChange

Event Type

Type	Description
OnFieldChange<Int32>

_onPrevIdChange

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

Declaration

protected event OnFieldChange<int> _onPrevIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnEntryIdChange

Event raised when EntryId is changing.

Declaration

public event OnFieldChange<int> OnEntryIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnExtraTablesResultChange

Event raised when ExtraTablesResult is changing.

Declaration

public event OnFieldChange<int> OnExtraTablesResultChange

Event Type

Type	Description
OnFieldChange<Int32>

OnNextIdChange

Event raised when NextId is changing.

Declaration

public event OnFieldChange<int> OnNextIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnOrderPosChange

Event raised when OrderPos is changing.

Declaration

public event OnFieldChange<int> OnOrderPosChange

Event Type

Type	Description
OnFieldChange<Int32>

OnPageNumChange

Event raised when PageNum is changing.

Declaration

public event OnFieldChange<int> OnPageNumChange

Event Type

Type	Description
OnFieldChange<Int32>

OnPrevIdChange

Event raised when PrevId is changing.

Declaration

public event OnFieldChange<int> OnPrevIdChange

Event Type

Type	Description
OnFieldChange<Int32>

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)