Class ForeignKeyRow

Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables.
Row Object for table 'foreignkey'. 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
ForeignKeyRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ForeignKeyRow : 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) ForeignKeyRow ForeignKeyRow.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(ForeignKeyRow.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 ForeignKeyTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ForeignKeyTableInfo) 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 ForeignKeyRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ForeignKeyTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ForeignKey are:

Index fieldsNested index class name

Constructors

ForeignKeyRow(ForeignKeyRow.ForeignKeyRowIdxBase)

Constructor for the class taking an index as argument. Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables.

Declaration
protected ForeignKeyRow(ForeignKeyRow.ForeignKeyRowIdxBase idx)
Parameters
Type Name Description
ForeignKeyRow.ForeignKeyRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentForeigndeviceId

Current value, see property ForeigndeviceId.

Declaration
protected int _currentForeigndeviceId
Field Value
Type Description
Int32

_currentForeignkeyId

Current value, see property ForeignkeyId.

Declaration
protected int _currentForeignkeyId
Field Value
Type Description
Int32

_currentRecordId

Current value, see property RecordId.

Declaration
protected int _currentRecordId
Field Value
Type Description
Int32

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
Int32

_currentSeqno

Current value, see property Seqno.

Declaration
protected int _currentSeqno
Field Value
Type Description
Int32

_currentSubkey

Current value, see property Subkey.

Declaration
protected string _currentSubkey
Field Value
Type Description
String

_currentSubvalue

Current value, see property Subvalue.

Declaration
protected string _currentSubvalue
Field Value
Type Description
String

_currentTableId

Current value, see property TableId.

Declaration
protected short _currentTableId
Field Value
Type Description
Int16

_currentUpdated

Current value, see property Updated.

Declaration
protected DateTime _currentUpdated
Field Value
Type Description
DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration
protected int _currentUpdatedAssociateId
Field Value
Type Description
Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration
protected short _currentUpdatedCount
Field Value
Type Description
Int16

_persistedForeigndeviceId

Persisted value, see property ForeigndeviceId.

Declaration
protected int _persistedForeigndeviceId
Field Value
Type Description
Int32

_persistedForeignkeyId

Persisted value, see property ForeignkeyId.

Declaration
protected int _persistedForeignkeyId
Field Value
Type Description
Int32

_persistedRecordId

Persisted value, see property RecordId.

Declaration
protected int _persistedRecordId
Field Value
Type Description
Int32

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
Int32

_persistedSeqno

Persisted value, see property Seqno.

Declaration
protected int _persistedSeqno
Field Value
Type Description
Int32

_persistedSubkey

Persisted value, see property Subkey.

Declaration
protected string _persistedSubkey
Field Value
Type Description
String

_persistedSubvalue

Persisted value, see property Subvalue.

Declaration
protected string _persistedSubvalue
Field Value
Type Description
String

_persistedTableId

Persisted value, see property TableId.

Declaration
protected short _persistedTableId
Field Value
Type Description
Int16

_persistedUpdated

Persisted value, see property Updated.

Declaration
protected DateTime _persistedUpdated
Field Value
Type Description
DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type Description
Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration
protected short _persistedUpdatedCount
Field Value
Type Description
Int16

Properties

ForeigndeviceId

.NET type: int. Reference to device definition

Declaration
public virtual int ForeigndeviceId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ForeignkeyId

.NET type: int. Primary key

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

ForeignKeyTableInfo

Get the ForeignKeyTableInfo object associated with the row.

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

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.

RecordId

.NET type: int. Record in the referenced table

Declaration
public virtual int RecordId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: RecordId.

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

Registered

.NET type: DateTime. Registered when in UTC

Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

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

RegisteredAssociateId

.NET type: int. Registered by whom

Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Seqno

.NET type: int. Sequence number, order of subkeys within one key

Declaration
public virtual int Seqno { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Id.

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

Subkey

.NET type: string. Subkey (optional)

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

Original type in dictionary: String[240].

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

Subvalue

.NET type: string. Key value

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

Original type in dictionary: String[240].

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

TableId

.NET type: short. SuperOffice table reference

Declaration
public virtual short TableId { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: TableNumber.

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

Updated

.NET type: DateTime. Last updated when in UTC

Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

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

UpdatedAssociateId

.NET type: int. Last updated by whom

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

UpdatedCount

.NET type: short. Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: UShort.

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 ForeignKeyRow object. Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables.

Declaration
public static ForeignKeyRow CreateNew()
Returns
Type Description
ForeignKeyRow

A new instance of the ForeignKeyRow object.

GetFromCustomSearch(ForeignKeyRow.CustomSearch)

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

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

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

GetFromIdxForeignkeyId(Int32)

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

Declaration
public static ForeignKeyRow GetFromIdxForeignkeyId(int foreignkeyId)
Parameters
Type Name Description
Int32 foreignkeyId
Returns
Type Description
ForeignKeyRow

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

GetFromReader(SoDataReader, ForeignKeyTableInfo)

Create a new instance of the ForeignKeyRow 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. Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables.

Declaration
public static ForeignKeyRow GetFromReader(SoDataReader reader, ForeignKeyTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ForeignKeyTableInfo tableInfo

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

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

_onForeigndeviceIdChange

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

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

_onRecordIdChange

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

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

_onRegisteredAssociateIdChange

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

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

_onRegisteredChange

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

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

_onSeqnoChange

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

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

_onSubkeyChange

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

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

_onSubvalueChange

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

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

_onTableIdChange

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

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

_onUpdatedAssociateIdChange

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

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

_onUpdatedChange

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

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

_onUpdatedCountChange

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

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

OnForeigndeviceIdChange

Event raised when ForeigndeviceId is changing.

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

OnRecordIdChange

Event raised when RecordId is changing.

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

OnRegisteredAssociateIdChange

Event raised when RegisteredAssociateId is changing.

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

OnRegisteredChange

Event raised when Registered is changing.

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

OnSeqnoChange

Event raised when Seqno is changing.

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

OnSubkeyChange

Event raised when Subkey is changing.

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

OnSubvalueChange

Event raised when Subvalue is changing.

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

OnTableIdChange

Event raised when TableId is changing.

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

OnUpdatedAssociateIdChange

Event raised when UpdatedAssociateId is changing.

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

OnUpdatedChange

Event raised when Updated is changing.

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

OnUpdatedCountChange

Event raised when UpdatedCount is changing.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)