Class QuoteAlternativeRows

Quote Version is made up of one or more Alternatives. One of 1..n possible alternatives in a Quote Version. The reason we have alternatives is that a quote can say to a customer, “we can solve you problem in two (or more) different ways, with different technology and sideeffects (and price)”. An Alternative may have discounts on the total amount. The Alternative tracks whether the user on the order level entered the Discount , Earning amount or the TotalPrice fields so that the discount and earning and total can be re-calculated correctly when Quote Lines are added or changed. Collection of QuoteAlternativeRow. Each element of the collection represents one row in the QuoteAlternative table.

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

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

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

Methods

Add(QuoteAlternativeRow)

Add one QuoteAlternativeRow to the collection.

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

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

The index of the added QuoteAlternativeRow.

AddNew()

Add a new instance of QuoteAlternativeRow added to the collection.

Declaration
public QuoteAlternativeRow AddNew()
Returns
Type Description
QuoteAlternativeRow

A new instance of QuoteAlternativeRow added to the collection.

AddRange(IEnumerable<QuoteAlternativeRow>)

Add a range of QuoteAlternativeRow to the collection.

Declaration
public QuoteAlternativeRows AddRange(IEnumerable<QuoteAlternativeRow> rows)
Parameters
Type Name Description
IEnumerableQuoteAlternativeRow rows
Returns
Type Description
QuoteAlternativeRows

The updated QuoteAlternativeRows collection object.

CreateChild()

Create a new instance of QuoteAlternativeRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of QuoteAlternativeRow
Overrides

CreateNew()

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

Declaration
public static QuoteAlternativeRows CreateNew()
Returns
Type Description
QuoteAlternativeRows

A new instance of the QuoteAlternativeRows object.

Find(Predicate<QuoteAlternativeRow>)

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

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

FindAll(Predicate<QuoteAlternativeRow>)

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

Declaration
public QuoteAlternativeRows FindAll(Predicate<QuoteAlternativeRow> condition)
Parameters
Type Name Description
PredicateQuoteAlternativeRow condition
Returns
Type Description
QuoteAlternativeRows

ForEach(Action<QuoteAlternativeRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskQuoteAlternativeRows

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

GetFromIdxERPQuoteAlternativeKeyAsync(string, CancellationToken)

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

Declaration
public static Task<QuoteAlternativeRows> GetFromIdxERPQuoteAlternativeKeyAsync(string eRPQuoteAlternativeKey, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string eRPQuoteAlternativeKey
CancellationToken cancellationToken
Returns
Type Description
TaskQuoteAlternativeRows

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

GetFromIdxQuoteVersionIdAsync(int, CancellationToken)

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

Declaration
public static Task<QuoteAlternativeRows> GetFromIdxQuoteVersionIdAsync(int quoteVersionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int quoteVersionId
CancellationToken cancellationToken
Returns
Type Description
TaskQuoteAlternativeRows

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

GetFromReaderAsync(SoDataReader, QuoteAlternativeTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
QuoteAlternativeTableInfo tableInfo

QuoteAlternativeTableInfo 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
TaskQuoteAlternativeRows

Remove(QuoteAlternativeRow)

Removes the given QuoteAlternativeRow from the collection

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

the QuoteAlternativeRow to be removed

ToArray()

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

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