Class InvoiceEntryRows

This table contain all invoices, connected to a message Collection of InvoiceEntryRow. Each element of the collection represents one row in the InvoiceEntry table.

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

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

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

Methods

Add(InvoiceEntryRow)

Add one InvoiceEntryRow to the collection.

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

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

The index of the added InvoiceEntryRow.

AddNew()

Add a new instance of InvoiceEntryRow added to the collection.

Declaration
public InvoiceEntryRow AddNew()
Returns
Type Description
InvoiceEntryRow

A new instance of InvoiceEntryRow added to the collection.

AddRange(IEnumerable<InvoiceEntryRow>)

Add a range of InvoiceEntryRow to the collection.

Declaration
public InvoiceEntryRows AddRange(IEnumerable<InvoiceEntryRow> rows)
Parameters
Type Name Description
IEnumerable<InvoiceEntryRow> rows
Returns
Type Description
InvoiceEntryRows

The updated InvoiceEntryRows collection object.

CreateChild()

Create a new instance of InvoiceEntryRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of InvoiceEntryRow
Overrides

CreateNew()

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

Declaration
public static InvoiceEntryRows CreateNew()
Returns
Type Description
InvoiceEntryRows

A new instance of the InvoiceEntryRows object.

Find(Predicate<InvoiceEntryRow>)

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

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

FindAll(Predicate<InvoiceEntryRow>)

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

Declaration
public InvoiceEntryRows FindAll(Predicate<InvoiceEntryRow> condition)
Parameters
Type Name Description
Predicate<InvoiceEntryRow> condition
Returns
Type Description
InvoiceEntryRows

ForEach(Action<InvoiceEntryRow>)

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

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

GetFromCustomSearch(InvoiceEntryRows.CustomSearch)

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

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

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

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

GetFromIdxDateInvoiced(DateTime)

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

Declaration
public static InvoiceEntryRows GetFromIdxDateInvoiced(DateTime dateInvoiced)
Parameters
Type Name Description
DateTime dateInvoiced
Returns
Type Description
InvoiceEntryRows

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

GetFromIdxMessageId(Int32)

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

Declaration
public static InvoiceEntryRows GetFromIdxMessageId(int messageId)
Parameters
Type Name Description
Int32 messageId
Returns
Type Description
InvoiceEntryRows

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

GetFromIdxType(Int32)

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

Declaration
public static InvoiceEntryRows GetFromIdxType(int type)
Parameters
Type Name Description
Int32 type
Returns
Type Description
InvoiceEntryRows

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

GetFromReader(SoDataReader, InvoiceEntryTableInfo)

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

SoDataReader positioned to a valid database row.
InvoiceEntryTableInfo tableInfo

InvoiceEntryTableInfo 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
InvoiceEntryRows

Remove(InvoiceEntryRow)

Removes the given InvoiceEntryRow from the collection

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

the InvoiceEntryRow to be removed

ToArray()

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

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)