Class SaleRows

Sales For every Sale record edited through the SuperOffice GUI, a copy of the previous version of the record will be saved in the SaleHist table. This also applies to editing done through the SaleModel COM interface, but not to editing done through the OLE DB Provider or other channels.
Collection of SaleRow. Each element of the collection represents one row in the Sale table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SaleRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SaleRows : 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 SaleRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) SaleRows SaleRows.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(SaleRows.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 SaleRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SaleTableInfo) 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 SaleRow given its index in the collection.

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

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

Methods

Add(SaleRow)

Add one SaleRow to the collection.

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

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

The index of the added SaleRow.

AddNew()

Add a new instance of SaleRow added to the collection.

Declaration
public SaleRow AddNew()
Returns
Type Description
SaleRow

A new instance of SaleRow added to the collection.

AddRange(IEnumerable<SaleRow>)

Add a range of SaleRow to the collection.

Declaration
public SaleRows AddRange(IEnumerable<SaleRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<SaleRow> rows
Returns
Type Description
SaleRows

The updated SaleRows collection object.

CreateChild()

Create a new instance of SaleRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SaleRow
Overrides

CreateNew()

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

Declaration
public static SaleRows CreateNew()
Returns
Type Description
SaleRows

A new instance of the SaleRows object.

Find(Predicate<SaleRow>)

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

Declaration
public SaleRow Find(Predicate<SaleRow> condition)
Parameters
Type Name Description
System.Predicate<SaleRow> condition
Returns
Type Description
SaleRow

FindAll(Predicate<SaleRow>)

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

Declaration
public SaleRows FindAll(Predicate<SaleRow> condition)
Parameters
Type Name Description
System.Predicate<SaleRow> condition
Returns
Type Description
SaleRows

ForEach(Action<SaleRow>)

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

Declaration
public void ForEach(Action<SaleRow> whatToDo)
Parameters
Type Name Description
System.Action<SaleRow> whatToDo

GetFromCustomSearch(SaleRows.CustomSearch)

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

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

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

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

GetFromIdxAssociateId(Int32)

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

Declaration
public static SaleRows GetFromIdxAssociateId(int associateId)
Parameters
Type Name Description
System.Int32 associateId
Returns
Type Description
SaleRows

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

GetFromIdxAssociateIdDone(Int32, SaleDone)

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

Declaration
public static SaleRows GetFromIdxAssociateIdDone(int associateId, SaleDone done)
Parameters
Type Name Description
System.Int32 associateId
SaleDone done
Returns
Type Description
SaleRows

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

GetFromIdxAssociateIdDoneSaledate(Int32, SaleDone, DateTime)

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

Declaration
public static SaleRows GetFromIdxAssociateIdDoneSaledate(int associateId, SaleDone done, DateTime saledate)
Parameters
Type Name Description
System.Int32 associateId
SaleDone done
System.DateTime saledate
Returns
Type Description
SaleRows

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

GetFromIdxContactId(Int32)

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

Declaration
public static SaleRows GetFromIdxContactId(int contactId)
Parameters
Type Name Description
System.Int32 contactId
Returns
Type Description
SaleRows

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

GetFromIdxContactIdSaledate(Int32, DateTime)

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

Declaration
public static SaleRows GetFromIdxContactIdSaledate(int contactId, DateTime saledate)
Parameters
Type Name Description
System.Int32 contactId
System.DateTime saledate
Returns
Type Description
SaleRows

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

GetFromIdxContactIdSaledateAssociateId(Int32, DateTime, Int32)

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

Declaration
public static SaleRows GetFromIdxContactIdSaledateAssociateId(int contactId, DateTime saledate, int associateId)
Parameters
Type Name Description
System.Int32 contactId
System.DateTime saledate
System.Int32 associateId
Returns
Type Description
SaleRows

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

GetFromIdxDone(SaleDone)

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

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

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

GetFromIdxHeading(String)

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

Declaration
public static SaleRows GetFromIdxHeading(string heading)
Parameters
Type Name Description
System.String heading
Returns
Type Description
SaleRows

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

GetFromIdxNumber1(String)

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

Declaration
public static SaleRows GetFromIdxNumber1(string number1)
Parameters
Type Name Description
System.String number1
Returns
Type Description
SaleRows

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

GetFromIdxPersonId(Int32)

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

Declaration
public static SaleRows GetFromIdxPersonId(int personId)
Parameters
Type Name Description
System.Int32 personId
Returns
Type Description
SaleRows

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

GetFromIdxProjectId(Int32)

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

Declaration
public static SaleRows GetFromIdxProjectId(int projectId)
Parameters
Type Name Description
System.Int32 projectId
Returns
Type Description
SaleRows

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

GetFromIdxProjectIdSaledate(Int32, DateTime)

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

Declaration
public static SaleRows GetFromIdxProjectIdSaledate(int projectId, DateTime saledate)
Parameters
Type Name Description
System.Int32 projectId
System.DateTime saledate
Returns
Type Description
SaleRows

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

GetFromIdxProjectIdSaledateAssociateId(Int32, DateTime, Int32)

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

Declaration
public static SaleRows GetFromIdxProjectIdSaledateAssociateId(int projectId, DateTime saledate, int associateId)
Parameters
Type Name Description
System.Int32 projectId
System.DateTime saledate
System.Int32 associateId
Returns
Type Description
SaleRows

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

GetFromIdxSaledate(DateTime)

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

Declaration
public static SaleRows GetFromIdxSaledate(DateTime saledate)
Parameters
Type Name Description
System.DateTime saledate
Returns
Type Description
SaleRows

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

GetFromIdxSource(Int16)

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

Declaration
public static SaleRows GetFromIdxSource(short source)
Parameters
Type Name Description
System.Int16 source
Returns
Type Description
SaleRows

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

GetFromIdxStatus(SaleStatus)

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

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

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

GetFromIdxUserdef2Id(Int32)

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

Declaration
public static SaleRows GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type Name Description
System.Int32 userdef2Id
Returns
Type Description
SaleRows

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

GetFromIdxUserdefId(Int32)

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

Declaration
public static SaleRows GetFromIdxUserdefId(int userdefId)
Parameters
Type Name Description
System.Int32 userdefId
Returns
Type Description
SaleRows

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

GetFromReader(SoDataReader, SaleTableInfo)

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

SoDataReader positioned to a valid database row.
SaleTableInfo tableInfo

SaleTableInfo 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
SaleRows

Remove(SaleRow)

Removes the given SaleRow from the collection

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

the SaleRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)