Class InvoiceSumRows

This table is used temporarily when listing invoice statistics. It is used because we need to sort balances from both customers and companies. Collection of InvoiceSumRow. Each element of the collection represents one row in the InvoiceSum table.

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

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

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

Methods

Add(InvoiceSumRow)

Add one InvoiceSumRow to the collection.

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

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

The index of the added InvoiceSumRow.

AddNew()

Add a new instance of InvoiceSumRow added to the collection.

Declaration
public InvoiceSumRow AddNew()
Returns
Type Description
InvoiceSumRow

A new instance of InvoiceSumRow added to the collection.

AddRange(IEnumerable<InvoiceSumRow>)

Add a range of InvoiceSumRow to the collection.

Declaration
public InvoiceSumRows AddRange(IEnumerable<InvoiceSumRow> rows)
Parameters
Type Name Description
IEnumerable<InvoiceSumRow> rows
Returns
Type Description
InvoiceSumRows

The updated InvoiceSumRows collection object.

CreateChild()

Create a new instance of InvoiceSumRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of InvoiceSumRow
Overrides

CreateNew()

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

Declaration
public static InvoiceSumRows CreateNew()
Returns
Type Description
InvoiceSumRows

A new instance of the InvoiceSumRows object.

Find(Predicate<InvoiceSumRow>)

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

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

FindAll(Predicate<InvoiceSumRow>)

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

Declaration
public InvoiceSumRows FindAll(Predicate<InvoiceSumRow> condition)
Parameters
Type Name Description
Predicate<InvoiceSumRow> condition
Returns
Type Description
InvoiceSumRows

ForEach(Action<InvoiceSumRow>)

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

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

GetFromCustomSearch(InvoiceSumRows.CustomSearch)

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

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

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

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

GetFromIdxCompanyId(Int32)

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

Declaration
public static InvoiceSumRows GetFromIdxCompanyId(int companyId)
Parameters
Type Name Description
Int32 companyId
Returns
Type Description
InvoiceSumRows

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

GetFromIdxCustomerId(Int32)

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

Declaration
public static InvoiceSumRows GetFromIdxCustomerId(int customerId)
Parameters
Type Name Description
Int32 customerId
Returns
Type Description
InvoiceSumRows

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

GetFromIdxLoginId(Int32)

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

Declaration
public static InvoiceSumRows GetFromIdxLoginId(int loginId)
Parameters
Type Name Description
Int32 loginId
Returns
Type Description
InvoiceSumRows

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

GetFromReader(SoDataReader, InvoiceSumTableInfo)

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

SoDataReader positioned to a valid database row.
InvoiceSumTableInfo tableInfo

InvoiceSumTableInfo 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
InvoiceSumRows

Remove(InvoiceSumRow)

Removes the given InvoiceSumRow from the collection

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

the InvoiceSumRow to be removed

ToArray()

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

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)