Class ConsentSourceRows

Consent source for GDPR Collection of ConsentSourceRow. Each element of the collection represents one row in the ConsentSource table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ConsentSourceRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ConsentSourceRows : 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 ConsentSourceRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) ConsentSourceRows ConsentSourceRows.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(ConsentSourceRows.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 ConsentSourceRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, ConsentSourceTableInfo) 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 ConsentSourceRow given its index in the collection.

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

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

Methods

Add(ConsentSourceRow)

Add one ConsentSourceRow to the collection.

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

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

The index of the added ConsentSourceRow.

AddNew()

Add a new instance of ConsentSourceRow added to the collection.

Declaration
public ConsentSourceRow AddNew()
Returns
Type Description
ConsentSourceRow

A new instance of ConsentSourceRow added to the collection.

AddRange(IEnumerable<ConsentSourceRow>)

Add a range of ConsentSourceRow to the collection.

Declaration
public ConsentSourceRows AddRange(IEnumerable<ConsentSourceRow> rows)
Parameters
Type Name Description
IEnumerable<ConsentSourceRow> rows
Returns
Type Description
ConsentSourceRows

The updated ConsentSourceRows collection object.

CreateChild()

Create a new instance of ConsentSourceRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ConsentSourceRow
Overrides

CreateNew()

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

Declaration
public static ConsentSourceRows CreateNew()
Returns
Type Description
ConsentSourceRows

A new instance of the ConsentSourceRows object.

Find(Predicate<ConsentSourceRow>)

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

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

FindAll(Predicate<ConsentSourceRow>)

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

Declaration
public ConsentSourceRows FindAll(Predicate<ConsentSourceRow> condition)
Parameters
Type Name Description
Predicate<ConsentSourceRow> condition
Returns
Type Description
ConsentSourceRows

ForEach(Action<ConsentSourceRow>)

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

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

GetFromCustomSearch(ConsentSourceRows.CustomSearch)

Create a new instance of the ConsentSourceRows 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 ConsentSourceRow objects representing each row will be returned.

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

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

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

GetFromReader(SoDataReader, ConsentSourceTableInfo)

Create a new instance of the ConsentSourceRows 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 ConsentSourceRow 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 ConsentSourceRows GetFromReader(SoDataReader reader, ConsentSourceTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ConsentSourceTableInfo tableInfo

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

Remove(ConsentSourceRow)

Removes the given ConsentSourceRow from the collection

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

the ConsentSourceRow to be removed

ToArray()

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

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)