Class PriceListRows

List of prices, cached from an ERP system Collection of PriceListRow. Each element of the collection represents one row in the PriceList table.

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

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

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

Methods

Add(PriceListRow)

Add one PriceListRow to the collection.

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

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

The index of the added PriceListRow.

AddNew()

Add a new instance of PriceListRow added to the collection.

Declaration
public PriceListRow AddNew()
Returns
Type Description
PriceListRow

A new instance of PriceListRow added to the collection.

AddRange(IEnumerable<PriceListRow>)

Add a range of PriceListRow to the collection.

Declaration
public PriceListRows AddRange(IEnumerable<PriceListRow> rows)
Parameters
Type Name Description
IEnumerable<PriceListRow> rows
Returns
Type Description
PriceListRows

The updated PriceListRows collection object.

CreateChild()

Create a new instance of PriceListRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PriceListRow
Overrides

CreateNew()

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

Declaration
public static PriceListRows CreateNew()
Returns
Type Description
PriceListRows

A new instance of the PriceListRows object.

Find(Predicate<PriceListRow>)

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

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

FindAll(Predicate<PriceListRow>)

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

Declaration
public PriceListRows FindAll(Predicate<PriceListRow> condition)
Parameters
Type Name Description
Predicate<PriceListRow> condition
Returns
Type Description
PriceListRows

ForEach(Action<PriceListRow>)

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

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

GetFromCustomSearch(PriceListRows.CustomSearch)

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

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

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

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

GetFromIdxCurrencyId(Int32)

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

Declaration
public static PriceListRows GetFromIdxCurrencyId(int currencyId)
Parameters
Type Name Description
Int32 currencyId
Returns
Type Description
PriceListRows

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

GetFromIdxValidFrom(DateTime)

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

Declaration
public static PriceListRows GetFromIdxValidFrom(DateTime validFrom)
Parameters
Type Name Description
DateTime validFrom
Returns
Type Description
PriceListRows

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

GetFromIdxValidFromValidTo(DateTime, DateTime)

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

Declaration
public static PriceListRows GetFromIdxValidFromValidTo(DateTime validFrom, DateTime validTo)
Parameters
Type Name Description
DateTime validFrom
DateTime validTo
Returns
Type Description
PriceListRows

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

GetFromIdxValidFromValidToIsActive(DateTime, DateTime, Int16)

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

Declaration
public static PriceListRows GetFromIdxValidFromValidToIsActive(DateTime validFrom, DateTime validTo, short isActive)
Parameters
Type Name Description
DateTime validFrom
DateTime validTo
Int16 isActive
Returns
Type Description
PriceListRows

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

GetFromIdxValidFromValidToIsActiveIsERPCopy(DateTime, DateTime, Int16, Int16)

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

Declaration
public static PriceListRows GetFromIdxValidFromValidToIsActiveIsERPCopy(DateTime validFrom, DateTime validTo, short isActive, short isERPCopy)
Parameters
Type Name Description
DateTime validFrom
DateTime validTo
Int16 isActive
Int16 isERPCopy
Returns
Type Description
PriceListRows

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

GetFromReader(SoDataReader, PriceListTableInfo)

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

SoDataReader positioned to a valid database row.
PriceListTableInfo tableInfo

PriceListTableInfo 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
PriceListRows

Remove(PriceListRow)

Removes the given PriceListRow from the collection

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

the PriceListRow to be removed

ToArray()

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

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)