Class MeteringLogRows

Metering log table Collection of MeteringLogRow. Each element of the collection represents one row in the MeteringLog table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
MeteringLogRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MeteringLogRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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

this[int]

Get a MeteringLogRow given its index in the collection.

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

Index of the MeteringLogRow in the collection
Property Value
Type Description
MeteringLogRow
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

Methods

Add(MeteringLogRow)

Add one MeteringLogRow to the collection.

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

An instance of MeteringLogRow to be added to the collection.
Returns
Type Description
int

The index of the added MeteringLogRow.
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

AddNew()

Add a new instance of MeteringLogRow added to the collection.

Declaration
public MeteringLogRow AddNew()
Returns
Type Description
MeteringLogRow

A new instance of MeteringLogRow added to the collection.
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

AddRange(IEnumerable<MeteringLogRow>)

Add a range of MeteringLogRow to the collection.

Declaration
public MeteringLogRows AddRange(IEnumerable<MeteringLogRow> rows)
Parameters
Type Name Description
IEnumerable<MeteringLogRow> rows
Returns
Type Description
MeteringLogRows

The updated MeteringLogRows collection object.
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

CreateChild()

Create a new instance of MeteringLogRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of MeteringLogRow
Overrides
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

CreateNew()

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

Declaration
public static MeteringLogRows CreateNew()
Returns
Type Description
MeteringLogRows

A new instance of the MeteringLogRows object.
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

Find(Predicate<MeteringLogRow>)

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

Declaration
public MeteringLogRow Find(Predicate<MeteringLogRow> condition)
Parameters
Type Name Description
Predicate<MeteringLogRow> condition
Returns
Type Description
MeteringLogRow
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

FindAll(Predicate<MeteringLogRow>)

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

Declaration
public MeteringLogRows FindAll(Predicate<MeteringLogRow> condition)
Parameters
Type Name Description
Predicate<MeteringLogRow> condition
Returns
Type Description
MeteringLogRows
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

ForEach(Action<MeteringLogRow>)

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

Declaration
public void ForEach(Action<MeteringLogRow> whatToDo)
Parameters
Type Name Description
Action<MeteringLogRow> whatToDo
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<MeteringLogRows> GetFromCustomSearchAsync(MeteringLogRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MeteringLogRows.CustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
Task<MeteringLogRows>

A new instance of the MeteringLogRows object, reflecting the result of the query.
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

GetFromIdxTableIdAsync(short, CancellationToken)

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

Declaration
public static Task<MeteringLogRows> GetFromIdxTableIdAsync(short tableId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short tableId
CancellationToken cancellationToken
Returns
Type Description
Task<MeteringLogRows>

Row object that represents the result of the search. IsNew 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 MeteringLog table. Non-unique indexes have corresponding inner classes and methods in the MeteringLogRows collection, since they may return more than one row.

GetFromIdxTableIdRecordIdAsync(short, int, CancellationToken)

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

Declaration
public static Task<MeteringLogRows> GetFromIdxTableIdRecordIdAsync(short tableId, int recordId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short tableId
int recordId
CancellationToken cancellationToken
Returns
Type Description
Task<MeteringLogRows>

Row object that represents the result of the search. IsNew 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 MeteringLog table. Non-unique indexes have corresponding inner classes and methods in the MeteringLogRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, MeteringLogTableInfo, CancellationToken)

Create a new instance of the MeteringLogRows 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 MeteringLogRow 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 Task<MeteringLogRows> GetFromReaderAsync(SoDataReader reader, MeteringLogTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
MeteringLogTableInfo tableInfo

MeteringLogTableInfo 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.
CancellationToken cancellationToken
Returns
Type Description
Task<MeteringLogRows>
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

Remove(MeteringLogRow)

Removes the given MeteringLogRow from the collection

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

the MeteringLogRow to be removed
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

ToArray()

Metering log table Collection of MeteringLogRow. Each element of the collection represents one row in the MeteringLog table.

Declaration
public MeteringLogRow[] ToArray()
Returns
Type Description
MeteringLogRow[]
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
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 MeteringLogRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) MeteringLogRows MeteringLogRows.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 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 MeteringLogRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.MeteringLogRows.GetFromReader 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).

Implements

Extension Methods