Class TableRowBase
Summary description for TableBase.
Inheritance
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public abstract class TableRowBase : PrivateSave, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItemConstructors
TableRowBase(IdxBase)
Constructor for the class, taking a unique index as argument
Declaration
protected TableRowBase(IdxBase idx)Parameters
| Type | Name | Description |
|---|---|---|
| SuperOffice.CRM.Rows.IdxBase | idx | The unique index used to load the object from the database. |
Fields
_isSaving
Declaration
protected bool _isSavingField Value
| Type | Description |
|---|---|
| System.Boolean |
_relatedNestedPersistMembers
Declaration
protected List<INestedPersist> _relatedNestedPersistMembersField Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<INestedPersist> |
_saveOwner
Declaration
protected INestedPersist _saveOwnerField Value
| Type | Description |
|---|---|
| INestedPersist |
_sentries
Declaration
protected SentryCollection _sentriesField Value
| Type | Description |
|---|---|
| SentryCollection |
_sqlType
Declaration
protected SqlType _sqlTypeField Value
| Type | Description |
|---|---|
| SqlType |
Properties
ForeignKeyHelper
Declaration
public RowForeignKeyHelper ForeignKeyHelper { get; }Property Value
| Type | Description |
|---|---|
| RowForeignKeyHelper |
IsDeleted
Has the row been deleted in the database.
Declaration
public virtual bool IsDeleted { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsDirty
Is the row dirty, e.g. been modified since the last time it was saved to the database.
Declaration
public virtual bool IsDirty { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsMarkedForDelete
Declaration
public bool IsMarkedForDelete { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsNew
Is the row new, e.g. not been inserted to the database?
Declaration
public abstract bool IsNew { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSaving
Is the nested persist in a saving state, hence disable Sentry when reading id's
Declaration
public virtual bool IsSaving { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSentryIgnored
Get value indicating whether sentry is ignored on the current object for the current thread.
Declaration
public override bool IsSentryIgnored { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Item[SoField]
Get or sets a value based on the SoField definition for a field
Declaration
public virtual object this[SoField fieldInfo] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| SoField | fieldInfo | Information about a field |
Property Value
| Type | Description |
|---|---|
| System.Object | Value of the field. |
Item[Int32]
Get or set a value based on the fields number.
Declaration
public virtual object this[int fieldId] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fieldId | Number of hte field |
Property Value
| Type | Description |
|---|---|
| System.Object | Value of the field. |
Item[String]
Get or set a value based on the name of the field.
Declaration
public abstract 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. |
Sentries
The collection of sentries that are guarding this row. This collection is automatically initialized by some HDB objects, and all RDB entities.
Declaration
public SentryCollection Sentries { get; }Property Value
| Type | Description |
|---|---|
| SentryCollection |
SqlType
The kind of Sql command this object represents.
Declaration
public override SqlType SqlType { get; }Property Value
| Type | Description |
|---|---|
| SqlType |
Overrides
Remarks
This object can be a delete, update or insert command.
TableInfo
Declaration
public abstract TableInfo TableInfo { get; }Property Value
| Type | Description |
|---|---|
| TableInfo |
Methods
add_OnElementIdUpdate(OnIdUpdate)
Declaration
public void add_OnElementIdUpdate(OnIdUpdate value)Parameters
| Type | Name | Description |
|---|---|---|
| OnIdUpdate | value |
add_OnElementSaved(OnSaved)
Declaration
public void add_OnElementSaved(OnSaved value)Parameters
| Type | Name | Description |
|---|---|---|
| OnSaved | value |
BeginIgnoreSentryCheck()
Starts the process of ignoring sentry on the object implementing the interface on the current thread.
Declaration
public override IgnoreSentryCheck BeginIgnoreSentryCheck()Returns
| Type | Description |
|---|---|
| IgnoreSentryCheck | Disposable object that calls EndIgnoreSentryCheck() on Dispose. |
Overrides
Delete()
Delete the row from the database.
Declaration
public virtual void Delete()EndIgnoreSentryCheck()
Ends the process of ignoring sentry on the object implementing the interface on the current thread.
Declaration
public override void EndIgnoreSentryCheck()Overrides
Exceptions
| Type | Condition |
|---|---|
| SoException | Thrown if Sentry is not ignored. |
GetFieldValue(FieldInfo)
Get the value of a field
Declaration
public override object GetFieldValue(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 ... |
Overrides
GetKnownFields()
All the fields, including custom fields.
Declaration
public List<FieldInfo> GetKnownFields()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<FieldInfo> | List of all fields on the table, including custom fields. |
GetRelatedNestedPersist()
Get an enumerator for all related nested persist members.
Declaration
protected virtual IEnumerable<INestedPersist> GetRelatedNestedPersist()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<INestedPersist> | Enumerator holding related nested persist members. |
InternalSetValue(SoField, Object)
Declaration
protected virtual void InternalSetValue(SoField fieldInfo, object value)Parameters
| Type | Name | Description |
|---|---|---|
| SoField | fieldInfo | |
| System.Object | value |
InternalSetValue(Int32, Object)
Declaration
protected virtual void InternalSetValue(int fieldId, object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fieldId | |
| System.Object | value |
InternalSetValue(String, Object)
Declaration
protected abstract void InternalSetValue(string fieldName, object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | |
| System.Object | value |
IsGhostField(FieldInfo)
Check if there is actually a valid value for the given field. If not, then this field is called a 'ghost'. This happens if a tablerow was 'fetched' but did not actually find its data in the database.
Declaration
public override bool IsGhostField(FieldInfo field)Parameters
| Type | Name | Description |
|---|---|---|
| FieldInfo | field | Specification of a field |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the field is a 'ghost', i.e., if it has NO valid known value |
Overrides
Remarks
In a TableRow object, we assume that either the whole row has been read, or none of it. Which field you're asking about is of less interest as long as it is one of ours.
Load(IdxBase, SoDataReader)
Populate a row based on a datareader.
Declaration
public void Load(IdxBase index, SoDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| SuperOffice.CRM.Rows.IdxBase | index | Index for the table that holds this row |
| SoDataReader | reader | Reader to read data from. |
Load(SoDataReader, TableInfo)
Populate a row based on a datareader
Declaration
public void Load(SoDataReader reader, TableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | Reader to read data from. |
| TableInfo | tableInfo | Instance of TableInfo holding |
OnIdUpdate()
Declaration
protected virtual void OnIdUpdate()OnLoad(SoDataReader, TableInfo)
Called when data is read from the database, to fill the road with appropriate data.
Declaration
protected virtual void OnLoad(SoDataReader reader, TableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader holding the data returned from the database. |
| TableInfo | tableInfo | The TableInfo used for the SELECT statement. |
OnLoaded(IdxBase)
Called when data is loaded from the database, to do further processing.
Declaration
protected virtual void OnLoaded(IdxBase index)Parameters
| Type | Name | Description |
|---|---|---|
| SuperOffice.CRM.Rows.IdxBase | index | Index used to load data from the database |
OnPreIdUpdate()
Allow for "fake id's" to be forced upon related objects.
Declaration
protected virtual void OnPreIdUpdate()Remarks
In order to figure out which objects taking part of the nested save operation that actually needs to be saved, this method allows for "fake id's" to be forced upon related objects. Upon receiving the "fake id", the objects receiving such an id can determine if they need to be persisted (e.g. saved) to the database. However, the fake id's forced upon related objects must be set to correct id's in the OnIdUpdate method taking place later in the save operation.
OnPrimaryKeyRequest(PKContainer)
Declaration
protected virtual void OnPrimaryKeyRequest(PKContainer pkContainer)Parameters
| Type | Name | Description |
|---|---|---|
| PKContainer | pkContainer |
Remarks
Check if the row is a INSERT or UPDATE command. If it is an INSERT command, an new primary key value is requested.
Validate to row.
OnPrimaryKeyUpdate(PKContainer)
Declaration
protected virtual void OnPrimaryKeyUpdate(PKContainer pkContainer)Parameters
| Type | Name | Description |
|---|---|---|
| PKContainer | pkContainer |
OnSave(BatchSave)
Declaration
protected virtual void OnSave(BatchSave batchSave)Parameters
| Type | Name | Description |
|---|---|---|
| BatchSave | batchSave |
OnSaved(Boolean)
Declaration
protected virtual void OnSaved(bool bSucceeded)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | bSucceeded |
remove_OnElementIdUpdate(OnIdUpdate)
Declaration
public void remove_OnElementIdUpdate(OnIdUpdate value)Parameters
| Type | Name | Description |
|---|---|---|
| OnIdUpdate | value |
remove_OnElementSaved(OnSaved)
Declaration
public void remove_OnElementSaved(OnSaved value)Parameters
| Type | Name | Description |
|---|---|---|
| OnSaved | value |
Reset()
Reset the changes made on the object.
Declaration
protected abstract void 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.
RowLoad()
Load the row from the database, using the provided unique index.
Declaration
protected void RowLoad()RowLoad(ITableRowLoadHandler)
Load the row from the database, using the provided unique index.
Declaration
protected void RowLoad(ITableRowLoadHandler handler)Parameters
| Type | Name | Description |
|---|---|---|
| ITableRowLoadHandler | handler |
Save()
Save all the contained objects to the database.
Declaration
public virtual void Save()SetDefaults()
Set default values for the row.
Declaration
public void SetDefaults()SetDefaults(DashboardTileDefinitionRow, String)
Set default values for the appointment's main row, and for any udef fields it may have.
Declaration
public void SetDefaults(DashboardTileDefinitionRow row, string entityName)Parameters
| Type | Name | Description |
|---|---|---|
| DashboardTileDefinitionRow | row | DashboardTileDefinitionRow |
| System.String | entityName | entity Name |
SetDefaults(DefaulterStrategy)
Set default values for the row.
Declaration
public abstract 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 |
SetDirty(Int32, Object, Object)
Force the object to be dirty.
Declaration
protected void SetDirty(int fieldId, object oldValue, object newValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fieldId | ID of the field that has changed |
| System.Object | oldValue | The value of the field prior to change. |
| System.Object | newValue | The value of the field after it was chaned. |
SetPrimaryKey(Int32)
Declaration
protected abstract void SetPrimaryKey(int primaryKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | primaryKey |
SetRowAsNew()
Declaration
public virtual void SetRowAsNew()SetSaveOwner(INestedPersist)
Declaration
public virtual void SetSaveOwner(INestedPersist saveOwner)Parameters
| Type | Name | Description |
|---|---|---|
| INestedPersist | saveOwner |
Validate()
Validate the row, for saving to the database
Declaration
public virtual RowValidator Validate()Returns
| Type | Description |
|---|---|
| RowValidator | The result of the validation. |
Validate(RowValidator)
Validate this row.
Declaration
public virtual void Validate(RowValidator rowValidator)Parameters
| Type | Name | Description |
|---|---|---|
| RowValidator | rowValidator | RowValidator for inserting the result of the validation |
Events
OnElementIdUpdate
Event raised when the item receives a primary key
Declaration
public event OnIdUpdate OnElementIdUpdateEvent Type
| Type | Description |
|---|---|
| OnIdUpdate |
OnElementSaved
Event raised when the item is saved to the database.
Declaration
public event OnSaved OnElementSavedEvent Type
| Type | Description |
|---|---|
| OnSaved |
Explicit Interface Implementations
ISoDataLookup.GetPersistedFieldValue(FieldInfo)
Get the persisted value of a field. One should always verify that the persisted value is
known using the method
Declaration
object ISoDataLookup.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. |
Exceptions
| Type | Condition |
|---|---|
| SoNotImplementedException | Thrown if the object implementing the interface does not support it. |
ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)
Check if the persisted value for a dield is known.
Declaration
bool ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo field)Parameters
| Type | Name | Description |
|---|---|---|
| FieldInfo | field | Specification of a field |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the value is known. |
INestedPersist.OnIdUpdate()
Declaration
void INestedPersist.OnIdUpdate()INestedPersist.OnPreIdUpdate()
Allow for "fake id's" to be forced upon related objects.
Declaration
void INestedPersist.OnPreIdUpdate()Remarks
In order to figure out which objects taking part of the nested save operation that actually needs to be saved, this method allows for "fake id's" to be forced upon related objects. Upon receiving the "fake id", the objects receiving such an id can determine if they need to be persisted (e.g. saved) to the database. However, the fake id's forced upon related objects must be set to correct id's in the OnIdUpdate method taking place later in the save operation.
INestedPersist.OnPrimaryKeyRequest(PKContainer)
Declaration
void INestedPersist.OnPrimaryKeyRequest(PKContainer pkContainer)Parameters
| Type | Name | Description |
|---|---|---|
| PKContainer | pkContainer |
INestedPersist.OnPrimaryKeyUpdate(PKContainer)
Declaration
void INestedPersist.OnPrimaryKeyUpdate(PKContainer pkContainer)Parameters
| Type | Name | Description |
|---|---|---|
| PKContainer | pkContainer |
INestedPersist.OnSave(BatchSave)
Declaration
void INestedPersist.OnSave(BatchSave batchSave)Parameters
| Type | Name | Description |
|---|---|---|
| BatchSave | batchSave |
INestedPersist.OnSaved(Boolean)
Declaration
void INestedPersist.OnSaved(bool bSucceeded)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | bSucceeded |