Class SaleHistRows

Mirror image of the Sale table, providing a full transaction history. Every time you edit a sale, the previous record of the sale is moved here. Collection of SaleHistRow. Each element of the collection represents one row in the SaleHist table.

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

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

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

Methods

Add(SaleHistRow)

Add one SaleHistRow to the collection.

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

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

The index of the added SaleHistRow.

AddNew()

Add a new instance of SaleHistRow added to the collection.

Declaration
public SaleHistRow AddNew()
Returns
Type Description
SaleHistRow

A new instance of SaleHistRow added to the collection.

AddRange(IEnumerable<SaleHistRow>)

Add a range of SaleHistRow to the collection.

Declaration
public SaleHistRows AddRange(IEnumerable<SaleHistRow> rows)
Parameters
Type Name Description
IEnumerable<SaleHistRow> rows
Returns
Type Description
SaleHistRows

The updated SaleHistRows collection object.

CreateChild()

Create a new instance of SaleHistRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SaleHistRow
Overrides

CreateNew()

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

Declaration
public static SaleHistRows CreateNew()
Returns
Type Description
SaleHistRows

A new instance of the SaleHistRows object.

Find(Predicate<SaleHistRow>)

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

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

FindAll(Predicate<SaleHistRow>)

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

Declaration
public SaleHistRows FindAll(Predicate<SaleHistRow> condition)
Parameters
Type Name Description
Predicate<SaleHistRow> condition
Returns
Type Description
SaleHistRows

ForEach(Action<SaleHistRow>)

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

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

GetFromCustomSearch(SaleHistRows.CustomSearch)

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

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

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

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

GetFromIdxContactId(Int32)

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

Declaration
public static SaleHistRows GetFromIdxContactId(int contactId)
Parameters
Type Name Description
Int32 contactId
Returns
Type Description
SaleHistRows

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

GetFromIdxDone(SaleDone)

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

Declaration
public static SaleHistRows GetFromIdxDone(SaleDone done)
Parameters
Type Name Description
SaleDone done
Returns
Type Description
SaleHistRows

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

GetFromIdxHeading(String)

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

Declaration
public static SaleHistRows GetFromIdxHeading(string heading)
Parameters
Type Name Description
String heading
Returns
Type Description
SaleHistRows

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

GetFromIdxNumber1(String)

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

Declaration
public static SaleHistRows GetFromIdxNumber1(string number1)
Parameters
Type Name Description
String number1
Returns
Type Description
SaleHistRows

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

GetFromIdxPersonId(Int32)

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

Declaration
public static SaleHistRows GetFromIdxPersonId(int personId)
Parameters
Type Name Description
Int32 personId
Returns
Type Description
SaleHistRows

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

GetFromIdxProjectId(Int32)

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

Declaration
public static SaleHistRows GetFromIdxProjectId(int projectId)
Parameters
Type Name Description
Int32 projectId
Returns
Type Description
SaleHistRows

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

GetFromIdxSaledate(DateTime)

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

Declaration
public static SaleHistRows GetFromIdxSaledate(DateTime saledate)
Parameters
Type Name Description
DateTime saledate
Returns
Type Description
SaleHistRows

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

GetFromIdxSaleId(Int32)

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

Declaration
public static SaleHistRows GetFromIdxSaleId(int saleId)
Parameters
Type Name Description
Int32 saleId
Returns
Type Description
SaleHistRows

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

GetFromIdxSource(Int16)

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

Declaration
public static SaleHistRows GetFromIdxSource(short source)
Parameters
Type Name Description
Int16 source
Returns
Type Description
SaleHistRows

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

GetFromIdxStatus(SaleStatus)

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

Declaration
public static SaleHistRows GetFromIdxStatus(SaleStatus status)
Parameters
Type Name Description
SaleStatus status
Returns
Type Description
SaleHistRows

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

GetFromIdxUserdef2Id(Int32)

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

Declaration
public static SaleHistRows GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type Name Description
Int32 userdef2Id
Returns
Type Description
SaleHistRows

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

GetFromIdxUserdefId(Int32)

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

Declaration
public static SaleHistRows GetFromIdxUserdefId(int userdefId)
Parameters
Type Name Description
Int32 userdefId
Returns
Type Description
SaleHistRows

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

GetFromReader(SoDataReader, SaleHistTableInfo)

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

SoDataReader positioned to a valid database row.
SaleHistTableInfo tableInfo

SaleHistTableInfo 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
SaleHistRows

Remove(SaleHistRow)

Removes the given SaleHistRow from the collection

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

the SaleHistRow to be removed

ToArray()

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

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)