Class RelationsRow
Instance of a relation, in principle between any two records, as long as they are defined in RelationDefinition. All instances of relations are held in this table; their definitions are in the RelDef table (RelDef + RelTarg define which relations you can have, this table contains the relations the user has actually entered). From 6.1 all links between appointments, sales and documents are also stored in this tabel.
Row Object for table 'relations'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class RelationsRow : 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) RelationsRow RelationsRow.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(RelationsRow.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 RelationsTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, RelationsTableInfo) 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.
Unique indexes on table Relations are:
Index fields | Nested index class name |
---|
Constructors
RelationsRow(RelationsRow.RelationsRowIdxBase)
Constructor for the class taking an index as argument. Instance of a relation, in principle between any two records, as long as they are defined in RelationDefinition. All instances of relations are held in this table; their definitions are in the RelDef table (RelDef + RelTarg define which relations you can have, this table contains the relations the user has actually entered). From 6.1 all links between appointments, sales and documents are also stored in this tabel.
Declaration
protected RelationsRow(RelationsRow.RelationsRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
RelationsRow.RelationsRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentAssociateId
Current value, see property AssociateId.
Declaration
protected int _currentAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_currentDestinationRecord
Current value, see property DestinationRecord.
Declaration
protected int _currentDestinationRecord
Field Value
Type | Description |
---|---|
Int32 |
_currentDestinationTable
Current value, see property DestinationTable.
Declaration
protected short _currentDestinationTable
Field Value
Type | Description |
---|---|
Int16 |
_currentEndDate
Current value, see property EndDate.
Declaration
protected DateTime _currentEndDate
Field Value
Type | Description |
---|---|
DateTime |
_currentGroupIdx
Current value, see property GroupIdx.
Declaration
protected int _currentGroupIdx
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 |
_currentRelationId
Current value, see property RelationId.
Declaration
protected int _currentRelationId
Field Value
Type | Description |
---|---|
Int32 |
_currentRelcomment
Current value, see property Relcomment.
Declaration
protected string _currentRelcomment
Field Value
Type | Description |
---|---|
String |
_currentReldefId
Current value, see property ReldefId.
Declaration
protected int _currentReldefId
Field Value
Type | Description |
---|---|
Int32 |
_currentRelFlags
Current value, see property RelFlags.
Declaration
protected uint _currentRelFlags
Field Value
Type | Description |
---|---|
UInt32 |
_currentReversed
Current value, see property Reversed.
Declaration
protected short _currentReversed
Field Value
Type | Description |
---|---|
Int16 |
_currentSourceRecord
Current value, see property SourceRecord.
Declaration
protected int _currentSourceRecord
Field Value
Type | Description |
---|---|
Int32 |
_currentSourceTable
Current value, see property SourceTable.
Declaration
protected short _currentSourceTable
Field Value
Type | Description |
---|---|
Int16 |
_currentStartDate
Current value, see property StartDate.
Declaration
protected DateTime _currentStartDate
Field Value
Type | Description |
---|---|
DateTime |
_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 |
_persistedAssociateId
Persisted value, see property AssociateId.
Declaration
protected int _persistedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_persistedDestinationRecord
Persisted value, see property DestinationRecord.
Declaration
protected int _persistedDestinationRecord
Field Value
Type | Description |
---|---|
Int32 |
_persistedDestinationTable
Persisted value, see property DestinationTable.
Declaration
protected short _persistedDestinationTable
Field Value
Type | Description |
---|---|
Int16 |
_persistedEndDate
Persisted value, see property EndDate.
Declaration
protected DateTime _persistedEndDate
Field Value
Type | Description |
---|---|
DateTime |
_persistedGroupIdx
Persisted value, see property GroupIdx.
Declaration
protected int _persistedGroupIdx
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 |
_persistedRelationId
Persisted value, see property RelationId.
Declaration
protected int _persistedRelationId
Field Value
Type | Description |
---|---|
Int32 |
_persistedRelcomment
Persisted value, see property Relcomment.
Declaration
protected string _persistedRelcomment
Field Value
Type | Description |
---|---|
String |
_persistedReldefId
Persisted value, see property ReldefId.
Declaration
protected int _persistedReldefId
Field Value
Type | Description |
---|---|
Int32 |
_persistedRelFlags
Persisted value, see property RelFlags.
Declaration
protected uint _persistedRelFlags
Field Value
Type | Description |
---|---|
UInt32 |
_persistedReversed
Persisted value, see property Reversed.
Declaration
protected short _persistedReversed
Field Value
Type | Description |
---|---|
Int16 |
_persistedSourceRecord
Persisted value, see property SourceRecord.
Declaration
protected int _persistedSourceRecord
Field Value
Type | Description |
---|---|
Int32 |
_persistedSourceTable
Persisted value, see property SourceTable.
Declaration
protected short _persistedSourceTable
Field Value
Type | Description |
---|---|
Int16 |
_persistedStartDate
Persisted value, see property StartDate.
Declaration
protected DateTime _persistedStartDate
Field Value
Type | Description |
---|---|
DateTime |
_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
AssociateId
.NET type: int. Owner of this relation record
Declaration
public virtual int AssociateId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will reset the Sentry and recalculate your rights based on the new value
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
DestinationRecord
.NET type: int. Actual target record
Declaration
public virtual int DestinationRecord { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: RecordId.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
DestinationTable
.NET type: short. Actual target table
Declaration
public virtual short DestinationTable { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: TableNumber.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
EndDate
.NET type: DateTime. End date of validity
Declaration
public virtual DateTime EndDate { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
GroupIdx
.NET type: int. User group owning this relation
Declaration
public virtual int GroupIdx { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will reset the Sentry and recalculate your rights based on the new value
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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. |
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.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
RelationId
.NET type: int. Primary key
Declaration
public virtual int RelationId { 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
RelationsTableInfo
Get the RelationsTableInfo object associated with the row.
Declaration
public RelationsTableInfo RelationsTableInfo { get; }
Property Value
Type | Description |
---|---|
RelationsTableInfo |
Relcomment
.NET type: string. Comment for relation
Declaration
public virtual string Relcomment { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[255].
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
ReldefId
.NET type: int. Reference to definition
Declaration
public virtual int ReldefId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
RelFlags
.NET type: uint. Relation flags, meaning as yet unspecified
Declaration
public virtual uint RelFlags { get; set; }
Property Value
Type | Description |
---|---|
UInt32 |
Remarks
Original type in dictionary: UInt.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((UInt32)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Reversed
.NET type: short. Is direction reversed relative to definition
Declaration
public virtual short Reversed { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
SourceRecord
.NET type: int. Actual source record
Declaration
public virtual int SourceRecord { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: RecordId.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
SourceTable
.NET type: short. Actual source table
Declaration
public virtual short SourceTable { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: TableNumber.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
StartDate
.NET type: DateTime. Start date of validity
Declaration
public virtual DateTime StartDate { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Methods
CreateNew()
Create a new instance of the RelationsRow object. Instance of a relation, in principle between any two records, as long as they are defined in RelationDefinition. All instances of relations are held in this table; their definitions are in the RelDef table (RelDef + RelTarg define which relations you can have, this table contains the relations the user has actually entered). From 6.1 all links between appointments, sales and documents are also stored in this tabel.
Declaration
public static RelationsRow CreateNew()
Returns
Type | Description |
---|---|
RelationsRow | A new instance of the RelationsRow object. |
GetFromCustomSearch(RelationsRow.CustomSearch)
Create a new instance of the RelationsRow 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 RelationsRow GetFromCustomSearch(RelationsRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
RelationsRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
RelationsRow | A new instance of the RelationsRow object, reflecting the result of the query. |
GetFromIdxRelationId(Int32)
Create a new instance of the RelationsRow object, by querying the database table via the index 'IDXRelId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static RelationsRow GetFromIdxRelationId(int relationId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | relationId |
Returns
Type | Description |
---|---|
RelationsRow | 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 Relations table. Non-unique indexes have corresponding inner classes and methods in the RelationsRows collection, since they may return more than one row.
GetFromReader(SoDataReader, RelationsTableInfo)
Create a new instance of the RelationsRow 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. Instance of a relation, in principle between any two records, as long as they are defined in RelationDefinition. All instances of relations are held in this table; their definitions are in the RelDef table (RelDef + RelTarg define which relations you can have, this table contains the relations the user has actually entered). From 6.1 all links between appointments, sales and documents are also stored in this tabel.
Declaration
public static RelationsRow GetFromReader(SoDataReader reader, RelationsTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
RelationsTableInfo | tableInfo | RelationsTableInfo 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 |
---|---|
RelationsRow | A new instance of the RelationsRow 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
_onAssociateIdChange
Change envent for property AssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDestinationRecordChange
Change envent for property DestinationRecord; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onDestinationRecordChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDestinationTableChange
Change envent for property DestinationTable; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onDestinationTableChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onEndDateChange
Change envent for property EndDate; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onEndDateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onGroupIdxChange
Change envent for property GroupIdx; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onGroupIdxChange
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> |
_onRelcommentChange
Change envent for property Relcomment; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onRelcommentChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onReldefIdChange
Change envent for property ReldefId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onReldefIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onRelFlagsChange
Change envent for property RelFlags; field is of .NET type uint.
Declaration
protected event OnFieldChange<uint> _onRelFlagsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
_onReversedChange
Change envent for property Reversed; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onReversedChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onSourceRecordChange
Change envent for property SourceRecord; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onSourceRecordChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onSourceTableChange
Change envent for property SourceTable; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onSourceTableChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onStartDateChange
Change envent for property StartDate; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onStartDateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_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> |
OnAssociateIdChange
Event raised when AssociateId is changing.
Declaration
public event OnFieldChange<int> OnAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDestinationRecordChange
Event raised when DestinationRecord is changing.
Declaration
public event OnFieldChange<int> OnDestinationRecordChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDestinationTableChange
Event raised when DestinationTable is changing.
Declaration
public event OnFieldChange<short> OnDestinationTableChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnEndDateChange
Event raised when EndDate is changing.
Declaration
public event OnFieldChange<DateTime> OnEndDateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnGroupIdxChange
Event raised when GroupIdx is changing.
Declaration
public event OnFieldChange<int> OnGroupIdxChange
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> |
OnRelcommentChange
Event raised when Relcomment is changing.
Declaration
public event OnFieldChange<string> OnRelcommentChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnReldefIdChange
Event raised when ReldefId is changing.
Declaration
public event OnFieldChange<int> OnReldefIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnRelFlagsChange
Event raised when RelFlags is changing.
Declaration
public event OnFieldChange<uint> OnRelFlagsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
OnReversedChange
Event raised when Reversed is changing.
Declaration
public event OnFieldChange<short> OnReversedChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnSourceRecordChange
Event raised when SourceRecord is changing.
Declaration
public event OnFieldChange<int> OnSourceRecordChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnSourceTableChange
Event raised when SourceTable is changing.
Declaration
public event OnFieldChange<short> OnSourceTableChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnStartDateChange
Event raised when StartDate is changing.
Declaration
public event OnFieldChange<DateTime> OnStartDateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
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> |