Class SListCustomerRows

Elements in a customer list. Collection of SListCustomerRow. Each element of the collection represents one row in the SListCustomer table.

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

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

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

Add one SListCustomerRow to the collection.

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

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

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

Declaration
public SListCustomerRow AddNew()
Returns
Type Description
SListCustomerRow

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

Add a range of SListCustomerRow to the collection.

Declaration
public SListCustomerRows AddRange(IEnumerable<SListCustomerRow> rows)
Parameters
Type Name Description
IEnumerable<SListCustomerRow> rows
Returns
Type Description
SListCustomerRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SListCustomerRow
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 SListCustomerRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SListCustomerRows SListCustomerRows.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(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 SListCustomerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SListCustomerTableInfo) 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 SListCustomerRows object. This collection will contain no rows.

Declaration
public static SListCustomerRows CreateNew()
Returns
Type Description
SListCustomerRows

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

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

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

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

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

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

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

GetFromCustomSearch(CustomSearch)

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

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

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

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

GetFromIdxCustomerId(int)

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

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

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

GetFromIdxListId(int)

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

Declaration
public static SListCustomerRows GetFromIdxListId(int listId)
Parameters
Type Name Description
int listId
Returns
Type Description
SListCustomerRows

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

GetFromReader(SoDataReader, SListCustomerTableInfo)

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

SoDataReader positioned to a valid database row.
SListCustomerTableInfo tableInfo

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

Removes the given SListCustomerRow from the collection

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

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

Elements in a customer list. Collection of SListCustomerRow. Each element of the collection represents one row in the SListCustomer table.

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