Show / Hide Table of Contents

Class ExtDatasourceRow

This table contains external datasources, used for databaseintegration of customers and companies.
Row Object for table 'ext_datasource'. 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
ExtDatasourceRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
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 ExtDatasourceRow : 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) ExtDatasourceRow ExtDatasourceRow.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(ExtDatasourceRow.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 ExtDatasourceTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ExtDatasourceTableInfo) 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 ExtDatasourceRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ExtDatasourceTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ExtDatasource are:

Index fieldsNested index class name

Constructors

ExtDatasourceRow(ExtDatasourceRow.ExtDatasourceRowIdxBase)

Constructor for the class taking an index as argument. This table contains external datasources, used for databaseintegration of customers and companies.

Declaration
protected ExtDatasourceRow(ExtDatasourceRow.ExtDatasourceRowIdxBase idx)
Parameters
Type Name Description
ExtDatasourceRow.ExtDatasourceRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentDatabaseType

Current value, see property DatabaseType.

Declaration
protected int _currentDatabaseType
Field Value
Type Description
Int32

_currentDatatype

Current value, see property Datatype.

Declaration
protected string _currentDatatype
Field Value
Type Description
String

_currentDbname

Current value, see property Dbname.

Declaration
protected string _currentDbname
Field Value
Type Description
String

_currentExtDatasourceId

Current value, see property ExtDatasourceId.

Declaration
protected int _currentExtDatasourceId
Field Value
Type Description
Int32

_currentFlags

Current value, see property Flags.

Declaration
protected int _currentFlags
Field Value
Type Description
Int32

_currentHostname

Current value, see property Hostname.

Declaration
protected string _currentHostname
Field Value
Type Description
String

_currentLastAccess

Current value, see property LastAccess.

Declaration
protected DateTime _currentLastAccess
Field Value
Type Description
DateTime

_currentLastUpdate

Current value, see property LastUpdate.

Declaration
protected DateTime _currentLastUpdate
Field Value
Type Description
DateTime

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentNextUpdate

Current value, see property NextUpdate.

Declaration
protected DateTime _currentNextUpdate
Field Value
Type Description
DateTime

_currentPassword

Current value, see property Password.

Declaration
protected string _currentPassword
Field Value
Type Description
String

_currentPath

Current value, see property Path.

Declaration
protected string _currentPath
Field Value
Type Description
String

_currentPort

Current value, see property Port.

Declaration
protected int _currentPort
Field Value
Type Description
Int32

_currentSqlInit

Current value, see property SqlInit.

Declaration
protected string _currentSqlInit
Field Value
Type Description
String

_currentUnixSocket

Current value, see property UnixSocket.

Declaration
protected string _currentUnixSocket
Field Value
Type Description
String

_currentUpdateCompanyCount

Current value, see property UpdateCompanyCount.

Declaration
protected int _currentUpdateCompanyCount
Field Value
Type Description
Int32

_currentUpdateCompletionTime

Current value, see property UpdateCompletionTime.

Declaration
protected int _currentUpdateCompletionTime
Field Value
Type Description
Int32

_currentUpdateCustomerCount

Current value, see property UpdateCustomerCount.

Declaration
protected int _currentUpdateCustomerCount
Field Value
Type Description
Int32

_currentUpdateErrorMessage

Current value, see property UpdateErrorMessage.

Declaration
protected string _currentUpdateErrorMessage
Field Value
Type Description
String

_currentUpdateInterval

Current value, see property UpdateInterval.

Declaration
protected int _currentUpdateInterval
Field Value
Type Description
Int32

_currentUpdateLock

Current value, see property UpdateLock.

Declaration
protected DateTime _currentUpdateLock
Field Value
Type Description
DateTime

_currentUsername

Current value, see property Username.

Declaration
protected string _currentUsername
Field Value
Type Description
String

_persistedDatabaseType

Persisted value, see property DatabaseType.

Declaration
protected int _persistedDatabaseType
Field Value
Type Description
Int32

_persistedDatatype

Persisted value, see property Datatype.

Declaration
protected string _persistedDatatype
Field Value
Type Description
String

_persistedDbname

Persisted value, see property Dbname.

Declaration
protected string _persistedDbname
Field Value
Type Description
String

_persistedExtDatasourceId

Persisted value, see property ExtDatasourceId.

Declaration
protected int _persistedExtDatasourceId
Field Value
Type Description
Int32

_persistedFlags

Persisted value, see property Flags.

Declaration
protected int _persistedFlags
Field Value
Type Description
Int32

_persistedHostname

Persisted value, see property Hostname.

Declaration
protected string _persistedHostname
Field Value
Type Description
String

_persistedLastAccess

Persisted value, see property LastAccess.

Declaration
protected DateTime _persistedLastAccess
Field Value
Type Description
DateTime

_persistedLastUpdate

Persisted value, see property LastUpdate.

Declaration
protected DateTime _persistedLastUpdate
Field Value
Type Description
DateTime

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedNextUpdate

Persisted value, see property NextUpdate.

Declaration
protected DateTime _persistedNextUpdate
Field Value
Type Description
DateTime

_persistedPassword

Persisted value, see property Password.

Declaration
protected string _persistedPassword
Field Value
Type Description
String

_persistedPath

Persisted value, see property Path.

Declaration
protected string _persistedPath
Field Value
Type Description
String

_persistedPort

Persisted value, see property Port.

Declaration
protected int _persistedPort
Field Value
Type Description
Int32

_persistedSqlInit

Persisted value, see property SqlInit.

Declaration
protected string _persistedSqlInit
Field Value
Type Description
String

_persistedUnixSocket

Persisted value, see property UnixSocket.

Declaration
protected string _persistedUnixSocket
Field Value
Type Description
String

_persistedUpdateCompanyCount

Persisted value, see property UpdateCompanyCount.

Declaration
protected int _persistedUpdateCompanyCount
Field Value
Type Description
Int32

_persistedUpdateCompletionTime

Persisted value, see property UpdateCompletionTime.

Declaration
protected int _persistedUpdateCompletionTime
Field Value
Type Description
Int32

_persistedUpdateCustomerCount

Persisted value, see property UpdateCustomerCount.

Declaration
protected int _persistedUpdateCustomerCount
Field Value
Type Description
Int32

_persistedUpdateErrorMessage

Persisted value, see property UpdateErrorMessage.

Declaration
protected string _persistedUpdateErrorMessage
Field Value
Type Description
String

_persistedUpdateInterval

Persisted value, see property UpdateInterval.

Declaration
protected int _persistedUpdateInterval
Field Value
Type Description
Int32

_persistedUpdateLock

Persisted value, see property UpdateLock.

Declaration
protected DateTime _persistedUpdateLock
Field Value
Type Description
DateTime

_persistedUsername

Persisted value, see property Username.

Declaration
protected string _persistedUsername
Field Value
Type Description
String

Properties

DatabaseType

.NET type: int. The database type (DbType).

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

Datatype

.NET type: string. An enum indicating the type/protocol for this datasource.

Declaration
public virtual string Datatype { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[33].

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

Dbname

.NET type: string. The name used for accessing the datasource.

Declaration
public virtual string Dbname { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[33].

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

ExtDatasourceId

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

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

ExtDatasourceTableInfo

Get the ExtDatasourceTableInfo object associated with the row.

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

Flags

.NET type: int. Bitmask of flags.

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

Hostname

.NET type: string. The hostname for accessing the datasource.

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

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.

LastAccess

.NET type: DateTime. The last time this datasource was accessed.

Declaration
public virtual DateTime LastAccess { get; set; }
Property Value
Type Description
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

LastUpdate

.NET type: DateTime. When did the last update occur?.

Declaration
public virtual DateTime LastUpdate { get; set; }
Property Value
Type Description
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

Name

.NET type: string. An alias for this datasource.

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[65].

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

NextUpdate

.NET type: DateTime. Next time the update process starts

Declaration
public virtual DateTime NextUpdate { get; set; }
Property Value
Type Description
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

Password

.NET type: string. The poassword used for authenticating against the datasource.

Declaration
public virtual string Password { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[65].

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

Path

.NET type: string. Path to the datasource.

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

Port

.NET type: int. The port used for accessing the datasource.

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

SqlInit

.NET type: string. The SQL init used for configure the server before fetching external data.

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

UnixSocket

.NET type: string. Unix socket used with Mysql connections on Linux

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

UpdateCompanyCount

.NET type: int. Number of companies updated so far

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

UpdateCompletionTime

.NET type: int. The last update completion time in minutes.

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

UpdateCustomerCount

.NET type: int. Number of customers updated so far

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

UpdateErrorMessage

.NET type: string. The last error message from datasource update.

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

UpdateInterval

.NET type: int. Number of hours between each database update

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

UpdateLock

.NET type: DateTime. Lock to make sure not 2 updates are done simultaniously

Declaration
public virtual DateTime UpdateLock { get; set; }
Property Value
Type Description
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

Username

.NET type: string. The username used for authenticating against the datasource.

Declaration
public virtual string Username { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[65].

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 ExtDatasourceRow object. This table contains external datasources, used for databaseintegration of customers and companies.

Declaration
public static ExtDatasourceRow CreateNew()
Returns
Type Description
ExtDatasourceRow

A new instance of the ExtDatasourceRow object.

GetFromCustomSearch(ExtDatasourceRow.CustomSearch)

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

The custom search to execute against the database

Returns
Type Description
ExtDatasourceRow

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

GetFromIdxExtDatasourceId(Int32)

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

Declaration
public static ExtDatasourceRow GetFromIdxExtDatasourceId(int extDatasourceId)
Parameters
Type Name Description
Int32 extDatasourceId
Returns
Type Description
ExtDatasourceRow

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

GetFromReader(SoDataReader, ExtDatasourceTableInfo)

Create a new instance of the ExtDatasourceRow 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. This table contains external datasources, used for databaseintegration of customers and companies.

Declaration
public static ExtDatasourceRow GetFromReader(SoDataReader reader, ExtDatasourceTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

ExtDatasourceTableInfo tableInfo

ExtDatasourceTableInfo 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
ExtDatasourceRow

A new instance of the ExtDatasourceRow 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

_onDatabaseTypeChange

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

Declaration
protected event OnFieldChange<int> _onDatabaseTypeChange
Event Type
Type Description
OnFieldChange<Int32>

_onDatatypeChange

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

Declaration
protected event OnFieldChange<string> _onDatatypeChange
Event Type
Type Description
OnFieldChange<String>

_onDbnameChange

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

Declaration
protected event OnFieldChange<string> _onDbnameChange
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>

_onHostnameChange

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

Declaration
protected event OnFieldChange<string> _onHostnameChange
Event Type
Type Description
OnFieldChange<String>

_onLastAccessChange

Change envent for property LastAccess; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastAccessChange
Event Type
Type Description
OnFieldChange<DateTime>

_onLastUpdateChange

Change envent for property LastUpdate; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastUpdateChange
Event Type
Type Description
OnFieldChange<DateTime>

_onNameChange

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

Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type Description
OnFieldChange<String>

_onNextUpdateChange

Change envent for property NextUpdate; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onNextUpdateChange
Event Type
Type Description
OnFieldChange<DateTime>

_onPasswordChange

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

Declaration
protected event OnFieldChange<string> _onPasswordChange
Event Type
Type Description
OnFieldChange<String>

_onPathChange

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

Declaration
protected event OnFieldChange<string> _onPathChange
Event Type
Type Description
OnFieldChange<String>

_onPortChange

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

Declaration
protected event OnFieldChange<int> _onPortChange
Event Type
Type Description
OnFieldChange<Int32>

_onSqlInitChange

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

Declaration
protected event OnFieldChange<string> _onSqlInitChange
Event Type
Type Description
OnFieldChange<String>

_onUnixSocketChange

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

Declaration
protected event OnFieldChange<string> _onUnixSocketChange
Event Type
Type Description
OnFieldChange<String>

_onUpdateCompanyCountChange

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

Declaration
protected event OnFieldChange<int> _onUpdateCompanyCountChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdateCompletionTimeChange

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

Declaration
protected event OnFieldChange<int> _onUpdateCompletionTimeChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdateCustomerCountChange

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

Declaration
protected event OnFieldChange<int> _onUpdateCustomerCountChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdateErrorMessageChange

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

Declaration
protected event OnFieldChange<string> _onUpdateErrorMessageChange
Event Type
Type Description
OnFieldChange<String>

_onUpdateIntervalChange

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

Declaration
protected event OnFieldChange<int> _onUpdateIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdateLockChange

Change envent for property UpdateLock; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onUpdateLockChange
Event Type
Type Description
OnFieldChange<DateTime>

_onUsernameChange

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

Declaration
protected event OnFieldChange<string> _onUsernameChange
Event Type
Type Description
OnFieldChange<String>

OnDatabaseTypeChange

Event raised when DatabaseType is changing.

Declaration
public event OnFieldChange<int> OnDatabaseTypeChange
Event Type
Type Description
OnFieldChange<Int32>

OnDatatypeChange

Event raised when Datatype is changing.

Declaration
public event OnFieldChange<string> OnDatatypeChange
Event Type
Type Description
OnFieldChange<String>

OnDbnameChange

Event raised when Dbname is changing.

Declaration
public event OnFieldChange<string> OnDbnameChange
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>

OnHostnameChange

Event raised when Hostname is changing.

Declaration
public event OnFieldChange<string> OnHostnameChange
Event Type
Type Description
OnFieldChange<String>

OnLastAccessChange

Event raised when LastAccess is changing.

Declaration
public event OnFieldChange<DateTime> OnLastAccessChange
Event Type
Type Description
OnFieldChange<DateTime>

OnLastUpdateChange

Event raised when LastUpdate is changing.

Declaration
public event OnFieldChange<DateTime> OnLastUpdateChange
Event Type
Type Description
OnFieldChange<DateTime>

OnNameChange

Event raised when Name is changing.

Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type Description
OnFieldChange<String>

OnNextUpdateChange

Event raised when NextUpdate is changing.

Declaration
public event OnFieldChange<DateTime> OnNextUpdateChange
Event Type
Type Description
OnFieldChange<DateTime>

OnPasswordChange

Event raised when Password is changing.

Declaration
public event OnFieldChange<string> OnPasswordChange
Event Type
Type Description
OnFieldChange<String>

OnPathChange

Event raised when Path is changing.

Declaration
public event OnFieldChange<string> OnPathChange
Event Type
Type Description
OnFieldChange<String>

OnPortChange

Event raised when Port is changing.

Declaration
public event OnFieldChange<int> OnPortChange
Event Type
Type Description
OnFieldChange<Int32>

OnSqlInitChange

Event raised when SqlInit is changing.

Declaration
public event OnFieldChange<string> OnSqlInitChange
Event Type
Type Description
OnFieldChange<String>

OnUnixSocketChange

Event raised when UnixSocket is changing.

Declaration
public event OnFieldChange<string> OnUnixSocketChange
Event Type
Type Description
OnFieldChange<String>

OnUpdateCompanyCountChange

Event raised when UpdateCompanyCount is changing.

Declaration
public event OnFieldChange<int> OnUpdateCompanyCountChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdateCompletionTimeChange

Event raised when UpdateCompletionTime is changing.

Declaration
public event OnFieldChange<int> OnUpdateCompletionTimeChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdateCustomerCountChange

Event raised when UpdateCustomerCount is changing.

Declaration
public event OnFieldChange<int> OnUpdateCustomerCountChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdateErrorMessageChange

Event raised when UpdateErrorMessage is changing.

Declaration
public event OnFieldChange<string> OnUpdateErrorMessageChange
Event Type
Type Description
OnFieldChange<String>

OnUpdateIntervalChange

Event raised when UpdateInterval is changing.

Declaration
public event OnFieldChange<int> OnUpdateIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdateLockChange

Event raised when UpdateLock is changing.

Declaration
public event OnFieldChange<DateTime> OnUpdateLockChange
Event Type
Type Description
OnFieldChange<DateTime>

OnUsernameChange

Event raised when Username is changing.

Declaration
public event OnFieldChange<string> OnUsernameChange
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)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top