Class CounterValueRows

Visible for rights Collection of CounterValueRow. Each element of the collection represents one row in the CounterValue table.

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

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

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

Methods

Add(CounterValueRow)

Add one CounterValueRow to the collection.

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

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

The index of the added CounterValueRow.

AddNew()

Add a new instance of CounterValueRow added to the collection.

Declaration
public CounterValueRow AddNew()
Returns
Type Description
CounterValueRow

A new instance of CounterValueRow added to the collection.

AddRange(IEnumerable<CounterValueRow>)

Add a range of CounterValueRow to the collection.

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

The updated CounterValueRows collection object.

CreateChild()

Create a new instance of CounterValueRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CounterValueRow
Overrides

CreateNew()

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

Declaration
public static CounterValueRows CreateNew()
Returns
Type Description
CounterValueRows

A new instance of the CounterValueRows object.

Find(Predicate<CounterValueRow>)

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

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

FindAll(Predicate<CounterValueRow>)

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

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

ForEach(Action<CounterValueRow>)

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

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

GetFromCustomSearch(CounterValueRows.CustomSearch)

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

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

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

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

GetFromIdxContactId(Int32)

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

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

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

GetFromIdxContactIdRecordType(Int32, Int16)

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

Declaration
public static CounterValueRows GetFromIdxContactIdRecordType(int contactId, short recordType)
Parameters
Type Name Description
System.Int32 contactId
System.Int16 recordType
Returns
Type Description
CounterValueRows

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

GetFromIdxContactIdSaleStatus(Int32, SaleStatus)

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

Declaration
public static CounterValueRows GetFromIdxContactIdSaleStatus(int contactId, SaleStatus saleStatus)
Parameters
Type Name Description
System.Int32 contactId
SaleStatus saleStatus
Returns
Type Description
CounterValueRows

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

GetFromIdxProjectId(Int32)

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

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

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

GetFromIdxProjectIdRecordType(Int32, Int16)

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

Declaration
public static CounterValueRows GetFromIdxProjectIdRecordType(int projectId, short recordType)
Parameters
Type Name Description
System.Int32 projectId
System.Int16 recordType
Returns
Type Description
CounterValueRows

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

GetFromIdxProjectIdSaleStatus(Int32, SaleStatus)

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

Declaration
public static CounterValueRows GetFromIdxProjectIdSaleStatus(int projectId, SaleStatus saleStatus)
Parameters
Type Name Description
System.Int32 projectId
SaleStatus saleStatus
Returns
Type Description
CounterValueRows

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

GetFromIdxRecordType(Int16)

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

Declaration
public static CounterValueRows GetFromIdxRecordType(short recordType)
Parameters
Type Name Description
System.Int16 recordType
Returns
Type Description
CounterValueRows

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

GetFromIdxRecordTypeDirection(Int16, Int16)

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

Declaration
public static CounterValueRows GetFromIdxRecordTypeDirection(short recordType, short direction)
Parameters
Type Name Description
System.Int16 recordType
System.Int16 direction
Returns
Type Description
CounterValueRows

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

GetFromIdxRecordTypeDirectionIntentId(Int16, Int16, Int32)

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

Declaration
public static CounterValueRows GetFromIdxRecordTypeDirectionIntentId(short recordType, short direction, int intentId)
Parameters
Type Name Description
System.Int16 recordType
System.Int16 direction
System.Int32 intentId
Returns
Type Description
CounterValueRows

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

GetFromIdxSaleStatus(SaleStatus)

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

Declaration
public static CounterValueRows GetFromIdxSaleStatus(SaleStatus saleStatus)
Parameters
Type Name Description
SaleStatus saleStatus
Returns
Type Description
CounterValueRows

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

GetFromIdxSaleStatusAmountClassId(SaleStatus, Int32)

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

Declaration
public static CounterValueRows GetFromIdxSaleStatusAmountClassId(SaleStatus saleStatus, int amountClassId)
Parameters
Type Name Description
SaleStatus saleStatus
System.Int32 amountClassId
Returns
Type Description
CounterValueRows

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

GetFromReader(SoDataReader, CounterValueTableInfo)

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

SoDataReader positioned to a valid database row.
CounterValueTableInfo tableInfo

CounterValueTableInfo 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
CounterValueRows

Remove(CounterValueRow)

Removes the given CounterValueRow from the collection

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

the CounterValueRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)