Class LockingRow

Generic locking and error messages
Row Object for table 'locking'. 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

LockingRow

Implements

Inherited Members

TableRowBase._saveOwner

TableRowBase._sentries

TableRowBase._relatedNestedPersistMembers

TableRowBase._isSaving

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.add_OnElementSaved(OnSaved)

TableRowBase.remove_OnElementSaved(OnSaved)

TableRowBase.add_OnElementIdUpdate(OnIdUpdate)

TableRowBase.remove_OnElementIdUpdate(OnIdUpdate)

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.OnElementSaved

TableRowBase.OnElementIdUpdate

PrivateSave.GetTableInfos()

PrivateSave.add_OnUpdateField(UpdateField)

PrivateSave.remove_OnUpdateField(UpdateField)

PrivateSave.CloneToBasicUpdatingQuery()

PrivateSave.SetTicketLogAction(TicketLogAction, String)

PrivateSave.DoNotWriteTraveltransactionLog

PrivateSave.OnUpdateField

SqlCommand.Origin

SqlCommand.AdditionalInfo

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

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

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

Unique indexes on table Locking are:

Index fields	Nested index class name

Constructors

LockingRow(LockingRow.LockingRowIdxBase)

Constructor for the class taking an index as argument. Generic locking and error messages

Declaration

protected LockingRow(LockingRow.LockingRowIdxBase idx)

Parameters

Type	Name	Description
SuperOffice.CRM.Rows.LockingRow.LockingRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentErrorMessage

Current value, see property ErrorMessage.

Declaration

protected string _currentErrorMessage

Field Value

Type	Description
System.String

_currentExecutionTime

Current value, see property ExecutionTime.

Declaration

protected int _currentExecutionTime

Field Value

Type	Description
System.Int32

_currentLastError

Current value, see property LastError.

Declaration

protected DateTime _currentLastError

Field Value

Type	Description
System.DateTime

_currentLastExecution

Current value, see property LastExecution.

Declaration

protected DateTime _currentLastExecution

Field Value

Type	Description
System.DateTime

_currentLockExpire

Current value, see property LockExpire.

Declaration

protected DateTime _currentLockExpire

Field Value

Type	Description
System.DateTime

_currentLockingId

Current value, see property LockingId.

Declaration

protected int _currentLockingId

Field Value

Type	Description
System.Int32

_currentLockPid

Current value, see property LockPid.

Declaration

protected int _currentLockPid

Field Value

Type	Description
System.Int32

_currentLockTtl

Current value, see property LockTtl.

Declaration

protected int _currentLockTtl

Field Value

Type	Description
System.Int32

_currentRetries

Current value, see property Retries.

Declaration

protected int _currentRetries

Field Value

Type	Description
System.Int32

_currentStatus

Current value, see property Status.

Declaration

protected short _currentStatus

Field Value

Type	Description
System.Int16

_currentStop

Current value, see property Stop.

Declaration

protected short _currentStop

Field Value

Type	Description
System.Int16

_persistedErrorMessage

Persisted value, see property ErrorMessage.

Declaration

protected string _persistedErrorMessage

Field Value

Type	Description
System.String

_persistedExecutionTime

Persisted value, see property ExecutionTime.

Declaration

protected int _persistedExecutionTime

Field Value

Type	Description
System.Int32

_persistedLastError

Persisted value, see property LastError.

Declaration

protected DateTime _persistedLastError

Field Value

Type	Description
System.DateTime

_persistedLastExecution

Persisted value, see property LastExecution.

Declaration

protected DateTime _persistedLastExecution

Field Value

Type	Description
System.DateTime

_persistedLockExpire

Persisted value, see property LockExpire.

Declaration

protected DateTime _persistedLockExpire

Field Value

Type	Description
System.DateTime

_persistedLockingId

Persisted value, see property LockingId.

Declaration

protected int _persistedLockingId

Field Value

Type	Description
System.Int32

_persistedLockPid

Persisted value, see property LockPid.

Declaration

protected int _persistedLockPid

Field Value

Type	Description
System.Int32

_persistedLockTtl

Persisted value, see property LockTtl.

Declaration

protected int _persistedLockTtl

Field Value

Type	Description
System.Int32

_persistedRetries

Persisted value, see property Retries.

Declaration

protected int _persistedRetries

Field Value

Type	Description
System.Int32

_persistedStatus

Persisted value, see property Status.

Declaration

protected short _persistedStatus

Field Value

Type	Description
System.Int16

_persistedStop

Persisted value, see property Stop.

Declaration

protected short _persistedStop

Field Value

Type	Description
System.Int16

Properties

ErrorMessage

.NET type: string. Last error message

Declaration

public virtual string ErrorMessage { 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

ExecutionTime

.NET type: int. Amount of time in seconds used by last execution

Declaration

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

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
System.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
System.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
System.String	fieldName	Name of the field in the database

Property Value

Type	Description
System.Object	Value of the field.

Overrides

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

LastError

.NET type: DateTime. Time of last error

Declaration

public virtual DateTime LastError { 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

LastExecution

.NET type: DateTime. Last execution

Declaration

public virtual DateTime LastExecution { 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

LockExpire

.NET type: DateTime. Lock preventing the same schedule to run simultaniously

Declaration

public virtual DateTime LockExpire { 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

LockingId

.NET type: int. Primary key

Declaration

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

LockingTableInfo

Get the LockingTableInfo object associated with the row.

Declaration

public LockingTableInfo LockingTableInfo { get; }

Property Value

Type	Description
LockingTableInfo

LockPid

.NET type: int. PID preventing the same schedule to run simultaniously

Declaration

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

LockTtl

.NET type: int. Lock time to live

Declaration

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

Retries

.NET type: int. Number of retries since last successfull execution

Declaration

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

Status

.NET type: short. Current status

Declaration

public virtual short Status { get; set; }

Property Value

Type	Description
System.Int16

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

Stop

.NET type: short. Signal to stop schedule

Declaration

public virtual short Stop { 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

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 LockingRow object. Generic locking and error messages

Declaration

public static LockingRow CreateNew()

Returns

Type	Description
LockingRow	A new instance of the LockingRow object.

GetFromCustomSearch(LockingRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxLockingId(Int32)

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

Declaration

public static LockingRow GetFromIdxLockingId(int lockingId)

Parameters

Type	Name	Description
System.Int32	lockingId

Returns

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

GetFromReader(SoDataReader, LockingTableInfo)

Create a new instance of the LockingRow 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. Generic locking and error messages

Declaration

public static LockingRow GetFromReader(SoDataReader reader, LockingTableInfo tableInfo)

Parameters

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

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

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

TableRowBase.Validate(RowValidator)

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)

QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)

QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)

QueryExectionExtensions.ExecuteNonQuery(SqlCommand)

LockingRecordDataExtensions.ToRecordData(LockingRow)

Converters.MapEnums<From, To>(From)