Class SelectionMemberRow

Selection detail table Each row in a selection is represented by one record in this table. Contact_id is always filled in, person_id is optional, but if used, must point to a person belonging to the contact in contact_id.
Row Object for table 'selectionmember'. 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
SelectionMemberRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SelectionMemberRow : 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) SelectionMemberRow SelectionMemberRow.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(SelectionMemberRow.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 SelectionMemberTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SelectionMemberTableInfo) 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 SelectionMemberRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, SelectionMemberTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table SelectionMember are:

Index fieldsNested index class name

Constructors

SelectionMemberRow(SelectionMemberRow.SelectionMemberRowIdxBase)

Constructor for the class taking an index as argument. Selection detail table Each row in a selection is represented by one record in this table. Contact_id is always filled in, person_id is optional, but if used, must point to a person belonging to the contact in contact_id.

Declaration
protected SelectionMemberRow(SelectionMemberRow.SelectionMemberRowIdxBase idx)
Parameters
Type Name Description
SelectionMemberRow.SelectionMemberRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentContactId

Current value, see property ContactId.

Declaration
protected int _currentContactId
Field Value
Type Description
Int32

_currentPersonId

Current value, see property PersonId.

Declaration
protected int _currentPersonId
Field Value
Type Description
Int32

_currentSelectionId

Current value, see property SelectionId.

Declaration
protected int _currentSelectionId
Field Value
Type Description
Int32

_currentSelectionmemberId

Current value, see property SelectionmemberId.

Declaration
protected int _currentSelectionmemberId
Field Value
Type Description
Int32

_currentTargetRecordId

Current value, see property TargetRecordId.

Declaration
protected int _currentTargetRecordId
Field Value
Type Description
Int32

_currentTargetTableNumber

Current value, see property TargetTableNumber.

Declaration
protected short _currentTargetTableNumber
Field Value
Type Description
Int16

_persistedContactId

Persisted value, see property ContactId.

Declaration
protected int _persistedContactId
Field Value
Type Description
Int32

_persistedPersonId

Persisted value, see property PersonId.

Declaration
protected int _persistedPersonId
Field Value
Type Description
Int32

_persistedSelectionId

Persisted value, see property SelectionId.

Declaration
protected int _persistedSelectionId
Field Value
Type Description
Int32

_persistedSelectionmemberId

Persisted value, see property SelectionmemberId.

Declaration
protected int _persistedSelectionmemberId
Field Value
Type Description
Int32

_persistedTargetRecordId

Persisted value, see property TargetRecordId.

Declaration
protected int _persistedTargetRecordId
Field Value
Type Description
Int32

_persistedTargetTableNumber

Persisted value, see property TargetTableNumber.

Declaration
protected short _persistedTargetTableNumber
Field Value
Type Description
Int16

Properties

ContactId

.NET type: int. Contact ID of selection member

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

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.

PersonId

.NET type: int. Person ID of selection member, if person

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

SelectionId

.NET type: int. Owning selection

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

SelectionmemberId

.NET type: int. Primary key

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

SelectionMemberTableInfo

Get the SelectionMemberTableInfo object associated with the row.

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

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

TargetRecordId

.NET type: int. Record id of the target that this selection member points to

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

TargetTableNumber

.NET type: short. Table number of the target that this selection member points to

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

Methods

CreateNew()

Create a new instance of the SelectionMemberRow object. Selection detail table Each row in a selection is represented by one record in this table. Contact_id is always filled in, person_id is optional, but if used, must point to a person belonging to the contact in contact_id.

Declaration
public static SelectionMemberRow CreateNew()
Returns
Type Description
SelectionMemberRow

A new instance of the SelectionMemberRow object.

GetFromCustomSearch(SelectionMemberRow.CustomSearch)

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

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

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

GetFromIdxSelectionmemberId(Int32)

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

Declaration
public static SelectionMemberRow GetFromIdxSelectionmemberId(int selectionmemberId)
Parameters
Type Name Description
Int32 selectionmemberId
Returns
Type Description
SelectionMemberRow

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

GetFromReader(SoDataReader, SelectionMemberTableInfo)

Create a new instance of the SelectionMemberRow 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. Selection detail table Each row in a selection is represented by one record in this table. Contact_id is always filled in, person_id is optional, but if used, must point to a person belonging to the contact in contact_id.

Declaration
public static SelectionMemberRow GetFromReader(SoDataReader reader, SelectionMemberTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
SelectionMemberTableInfo tableInfo

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

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

_onContactIdChange

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

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

_onPersonIdChange

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

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

_onSelectionIdChange

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

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

_onTargetRecordIdChange

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

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

_onTargetTableNumberChange

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

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

OnContactIdChange

Event raised when ContactId is changing.

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

OnPersonIdChange

Event raised when PersonId is changing.

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

OnSelectionIdChange

Event raised when SelectionId is changing.

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

OnTargetRecordIdChange

Event raised when TargetRecordId is changing.

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

OnTargetTableNumberChange

Event raised when TargetTableNumber is changing.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)