Class DbiAgentRow

DBI agent settings
Row Object for table 'dbi_agent'. 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
DbiAgentRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class DbiAgentRow : 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) DbiAgentRow DbiAgentRow.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(DbiAgentRow.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 DbiAgentTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DbiAgentTableInfo) 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 DbiAgentRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, DbiAgentTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table DbiAgent are:

Index fieldsNested index class name

Constructors

DbiAgentRow(DbiAgentRow.DbiAgentRowIdxBase)

Constructor for the class taking an index as argument. DBI agent settings

Declaration
protected DbiAgentRow(DbiAgentRow.DbiAgentRowIdxBase idx)
Parameters
Type Name Description
DbiAgentRow.DbiAgentRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentDbiAgentId

Current value, see property DbiAgentId.

Declaration
protected int _currentDbiAgentId
Field Value
Type Description
Int32

_currentIdString

Current value, see property IdString.

Declaration
protected string _currentIdString
Field Value
Type Description
String

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentPath

Current value, see property Path.

Declaration
protected string _currentPath
Field Value
Type Description
String

_currentProtocol

Current value, see property Protocol.

Declaration
protected short _currentProtocol
Field Value
Type Description
Int16

_persistedDbiAgentId

Persisted value, see property DbiAgentId.

Declaration
protected int _persistedDbiAgentId
Field Value
Type Description
Int32

_persistedIdString

Persisted value, see property IdString.

Declaration
protected string _persistedIdString
Field Value
Type Description
String

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedPath

Persisted value, see property Path.

Declaration
protected string _persistedPath
Field Value
Type Description
String

_persistedProtocol

Persisted value, see property Protocol.

Declaration
protected short _persistedProtocol
Field Value
Type Description
Int16

Properties

DbiAgentId

.NET type: int. Primary key

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

DbiAgentTableInfo

Get the DbiAgentTableInfo object associated with the row.

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

IdString

.NET type: string. A field for an id_string which may be used to access the dbi agent

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

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

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides

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

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

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
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

Name

.NET type: string. Agent name

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

Path

.NET type: string. Path to agent URL or file path

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

Protocol

.NET type: short. Agent communcication protocol

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

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

Methods

CreateNew()

Create a new instance of the DbiAgentRow object. DBI agent settings

Declaration
public static DbiAgentRow CreateNew()
Returns
Type Description
DbiAgentRow

A new instance of the DbiAgentRow object.

GetFromCustomSearch(DbiAgentRow.CustomSearch)

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

The custom search to execute against the database
Returns
Type Description
DbiAgentRow

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

GetFromIdxDbiAgentId(Int32)

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

Declaration
public static DbiAgentRow GetFromIdxDbiAgentId(int dbiAgentId)
Parameters
Type Name Description
Int32 dbiAgentId
Returns
Type Description
DbiAgentRow

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

GetFromReader(SoDataReader, DbiAgentTableInfo)

Create a new instance of the DbiAgentRow 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. DBI agent settings

Declaration
public static DbiAgentRow GetFromReader(SoDataReader reader, DbiAgentTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
DbiAgentTableInfo tableInfo

DbiAgentTableInfo 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
DbiAgentRow

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

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

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

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

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
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

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

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

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

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

Events

_onIdStringChange

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

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

_onNameChange

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

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

_onProtocolChange

Change envent for property Protocol; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onProtocolChange
Event Type
Type Description
OnFieldChange<Int16>

OnIdStringChange

Event raised when IdString is changing.

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

OnNameChange

Event raised when Name is changing.

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

OnProtocolChange

Event raised when Protocol is changing.

Declaration
public event OnFieldChange<short> OnProtocolChange
Event Type
Type Description
OnFieldChange<Int16>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)