Class IntentRows

Intent list for SAINT. More information regarding SuperOffice Sales Intelligence on http://techdoc.superoffice.com Collection of IntentRow. Each element of the collection represents one row in the Intent table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
IntentRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class IntentRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, 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 IntentRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) IntentRows IntentRows.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(IntentRows.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 IntentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, IntentTableInfo) 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 IntentRow given its index in the collection.

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

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

Methods

Add(IntentRow)

Add one IntentRow to the collection.

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

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

The index of the added IntentRow.

AddNew()

Add a new instance of IntentRow added to the collection.

Declaration
public IntentRow AddNew()
Returns
Type Description
IntentRow

A new instance of IntentRow added to the collection.

AddRange(IEnumerable<IntentRow>)

Add a range of IntentRow to the collection.

Declaration
public IntentRows AddRange(IEnumerable<IntentRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IntentRow> rows
Returns
Type Description
IntentRows

The updated IntentRows collection object.

CreateChild()

Create a new instance of IntentRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of IntentRow
Overrides

CreateNew()

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

Declaration
public static IntentRows CreateNew()
Returns
Type Description
IntentRows

A new instance of the IntentRows object.

Find(Predicate<IntentRow>)

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

Declaration
public IntentRow Find(Predicate<IntentRow> condition)
Parameters
Type Name Description
System.Predicate<IntentRow> condition
Returns
Type Description
IntentRow

FindAll(Predicate<IntentRow>)

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

Declaration
public IntentRows FindAll(Predicate<IntentRow> condition)
Parameters
Type Name Description
System.Predicate<IntentRow> condition
Returns
Type Description
IntentRows

ForEach(Action<IntentRow>)

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

Declaration
public void ForEach(Action<IntentRow> whatToDo)
Parameters
Type Name Description
System.Action<IntentRow> whatToDo

GetFromCustomSearch(IntentRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, IntentTableInfo)

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

SoDataReader positioned to a valid database row.
IntentTableInfo tableInfo

IntentTableInfo 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
IntentRows

Remove(IntentRow)

Removes the given IntentRow from the collection

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

the IntentRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)