Class AmountClassRows

Amount Class list for SuperOffice Sales Intelligence (Saint) - used to group sales by amounts, into bins (low --> high) called amount classes. More information regarding SuperOffice Sales Intelligence on http://techdoc.superoffice.com Collection of AmountClassRow. Each element of the collection represents one row in the AmountClass table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
AmountClassRows
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 AmountClassRows : 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 AmountClassRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) AmountClassRows AmountClassRows.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(AmountClassRows.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 AmountClassRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, AmountClassTableInfo) 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 AmountClassRow given its index in the collection.

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

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

Methods

Add(AmountClassRow)

Add one AmountClassRow to the collection.

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

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

The index of the added AmountClassRow.

AddNew()

Add a new instance of AmountClassRow added to the collection.

Declaration
public AmountClassRow AddNew()
Returns
Type Description
AmountClassRow

A new instance of AmountClassRow added to the collection.

AddRange(IEnumerable<AmountClassRow>)

Add a range of AmountClassRow to the collection.

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

The updated AmountClassRows collection object.

CreateChild()

Create a new instance of AmountClassRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of AmountClassRow
Overrides

CreateNew()

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

Declaration
public static AmountClassRows CreateNew()
Returns
Type Description
AmountClassRows

A new instance of the AmountClassRows object.

Find(Predicate<AmountClassRow>)

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

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

FindAll(Predicate<AmountClassRow>)

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

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

ForEach(Action<AmountClassRow>)

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

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

GetFromCustomSearch(AmountClassRows.CustomSearch)

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

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

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

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

GetFromIdxAmountFrom(Double)

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

Declaration
public static AmountClassRows GetFromIdxAmountFrom(double amountFrom)
Parameters
Type Name Description
System.Double amountFrom
Returns
Type Description
AmountClassRows

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

GetFromIdxAmountTo(Double)

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

Declaration
public static AmountClassRows GetFromIdxAmountTo(double amountTo)
Parameters
Type Name Description
System.Double amountTo
Returns
Type Description
AmountClassRows

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

GetFromReader(SoDataReader, AmountClassTableInfo)

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

SoDataReader positioned to a valid database row.
AmountClassTableInfo tableInfo

AmountClassTableInfo 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
AmountClassRows

Remove(AmountClassRow)

Removes the given AmountClassRow from the collection

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

the AmountClassRow to be removed

ToArray()

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

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)