Class SelectionMemberRows

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. Collection of SelectionMemberRow. Each element of the collection represents one row in the SelectionMember table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SelectionMemberRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SelectionMemberRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
Remarks

Row collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SelectionMemberRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) SelectionMemberRows SelectionMemberRows.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(SelectionMemberRows.CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the SelectionMemberRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SelectionMemberTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a SelectionMemberRow given its index in the collection.

Declaration
public SelectionMemberRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the SelectionMemberRow in the collection
Property Value
Type Description
SelectionMemberRow

Methods

Add(SelectionMemberRow)

Add one SelectionMemberRow to the collection.

Declaration
public int Add(SelectionMemberRow row)
Parameters
Type Name Description
SelectionMemberRow row

An instance of SelectionMemberRow to be added to the collection.
Returns
Type Description
Int32

The index of the added SelectionMemberRow.

AddNew()

Add a new instance of SelectionMemberRow added to the collection.

Declaration
public SelectionMemberRow AddNew()
Returns
Type Description
SelectionMemberRow

A new instance of SelectionMemberRow added to the collection.

AddRange(IEnumerable<SelectionMemberRow>)

Add a range of SelectionMemberRow to the collection.

Declaration
public SelectionMemberRows AddRange(IEnumerable<SelectionMemberRow> rows)
Parameters
Type Name Description
IEnumerable<SelectionMemberRow> rows
Returns
Type Description
SelectionMemberRows

The updated SelectionMemberRows collection object.

CreateChild()

Create a new instance of SelectionMemberRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SelectionMemberRow
Overrides

CreateNew()

Create a new instance of the SelectionMemberRows object. This collection will contain no rows.

Declaration
public static SelectionMemberRows CreateNew()
Returns
Type Description
SelectionMemberRows

A new instance of the SelectionMemberRows object.

Find(Predicate<SelectionMemberRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public SelectionMemberRow Find(Predicate<SelectionMemberRow> condition)
Parameters
Type Name Description
Predicate<SelectionMemberRow> condition
Returns
Type Description
SelectionMemberRow

FindAll(Predicate<SelectionMemberRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public SelectionMemberRows FindAll(Predicate<SelectionMemberRow> condition)
Parameters
Type Name Description
Predicate<SelectionMemberRow> condition
Returns
Type Description
SelectionMemberRows

ForEach(Action<SelectionMemberRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<SelectionMemberRow> whatToDo)
Parameters
Type Name Description
Action<SelectionMemberRow> whatToDo

GetFromCustomSearch(SelectionMemberRows.CustomSearch)

Create a new instance of the SelectionMemberRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SelectionMemberRow objects representing each row will be returned.

Declaration
public static SelectionMemberRows GetFromCustomSearch(SelectionMemberRows.CustomSearch query)
Parameters
Type Name Description
SelectionMemberRows.CustomSearch query

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

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

GetFromIdxContactId(Int32)

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

Declaration
public static SelectionMemberRows GetFromIdxContactId(int contactId)
Parameters
Type Name Description
Int32 contactId
Returns
Type Description
SelectionMemberRows

Row object that represents the result of the search. 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.

GetFromIdxContactIdPersonId(Int32, Int32)

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

Declaration
public static SelectionMemberRows GetFromIdxContactIdPersonId(int contactId, int personId)
Parameters
Type Name Description
Int32 contactId
Int32 personId
Returns
Type Description
SelectionMemberRows

Row object that represents the result of the search. 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.

GetFromIdxPersonId(Int32)

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

Declaration
public static SelectionMemberRows GetFromIdxPersonId(int personId)
Parameters
Type Name Description
Int32 personId
Returns
Type Description
SelectionMemberRows

Row object that represents the result of the search. 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.

GetFromIdxSelectionId(Int32)

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

Declaration
public static SelectionMemberRows GetFromIdxSelectionId(int selectionId)
Parameters
Type Name Description
Int32 selectionId
Returns
Type Description
SelectionMemberRows

Row object that represents the result of the search. 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.

GetFromIdxSelectionIdContactId(Int32, Int32)

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

Declaration
public static SelectionMemberRows GetFromIdxSelectionIdContactId(int selectionId, int contactId)
Parameters
Type Name Description
Int32 selectionId
Int32 contactId
Returns
Type Description
SelectionMemberRows

Row object that represents the result of the search. 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 SelectionMemberRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SelectionMemberRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration
public static SelectionMemberRows 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
SelectionMemberRows

Remove(SelectionMemberRow)

Removes the given SelectionMemberRow from the collection

Declaration
public void Remove(SelectionMemberRow row)
Parameters
Type Name Description
SelectionMemberRow row

the SelectionMemberRow to be removed

ToArray()

Declaration
public SelectionMemberRow[] ToArray()
Returns
Type Description
SelectionMemberRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)