Class RefCountsRows

Number counter for all tables that generate numbers, e.g. templates, contacts... This table is used for the number allocation system and should not be confused with sequence, used for allocating internal ID's. This table is replicated during generation of satellites and during local update for travellers, using special logic. By default it contains rows for the SuperOffice standard counters, including one row for each DocTemplate record. It is permissible to add new rows to this table, and such records are maintainable through the Maintenance client. Changing the contents of the standard records is not recommended. Collection of RefCountsRow. Each element of the collection represents one row in the RefCounts table.

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

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

Index of the RefCountsRow in the collection
Property Value
Type Description
RefCountsRow
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

Methods

Add(RefCountsRow)

Add one RefCountsRow to the collection.

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

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

The index of the added RefCountsRow.
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

AddNew()

Add a new instance of RefCountsRow added to the collection.

Declaration
public RefCountsRow AddNew()
Returns
Type Description
RefCountsRow

A new instance of RefCountsRow added to the collection.
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

AddRange(IEnumerable<RefCountsRow>)

Add a range of RefCountsRow to the collection.

Declaration
public RefCountsRows AddRange(IEnumerable<RefCountsRow> rows)
Parameters
Type Name Description
IEnumerable<RefCountsRow> rows
Returns
Type Description
RefCountsRows

The updated RefCountsRows collection object.
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

CreateChild()

Create a new instance of RefCountsRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of RefCountsRow
Overrides
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

CreateNew()

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

Declaration
public static RefCountsRows CreateNew()
Returns
Type Description
RefCountsRows

A new instance of the RefCountsRows object.
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

Find(Predicate<RefCountsRow>)

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

Declaration
public RefCountsRow Find(Predicate<RefCountsRow> condition)
Parameters
Type Name Description
Predicate<RefCountsRow> condition
Returns
Type Description
RefCountsRow
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

FindAll(Predicate<RefCountsRow>)

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

Declaration
public RefCountsRows FindAll(Predicate<RefCountsRow> condition)
Parameters
Type Name Description
Predicate<RefCountsRow> condition
Returns
Type Description
RefCountsRows
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

ForEach(Action<RefCountsRow>)

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

Declaration
public void ForEach(Action<RefCountsRow> whatToDo)
Parameters
Type Name Description
Action<RefCountsRow> whatToDo
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

GetFromCustomSearch(RefCountsRows.CustomSearch)

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

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

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

A new instance of the RefCountsRows object, reflecting the result of the query.
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

GetFromIdxFieldId(Int32)

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

Declaration
public static RefCountsRows GetFromIdxFieldId(int fieldId)
Parameters
Type Name Description
Int32 fieldId
Returns
Type Description
RefCountsRows

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

GetFromIdxFieldIdRecordId(Int32, Int32)

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

Declaration
public static RefCountsRows GetFromIdxFieldIdRecordId(int fieldId, int recordId)
Parameters
Type Name Description
Int32 fieldId
Int32 recordId
Returns
Type Description
RefCountsRows

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

GetFromIdxRecordId(Int32)

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

Declaration
public static RefCountsRows GetFromIdxRecordId(int recordId)
Parameters
Type Name Description
Int32 recordId
Returns
Type Description
RefCountsRows

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

GetFromReader(SoDataReader, RefCountsTableInfo)

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

SoDataReader positioned to a valid database row.
RefCountsTableInfo tableInfo

RefCountsTableInfo 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
RefCountsRows
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

Remove(RefCountsRow)

Removes the given RefCountsRow from the collection

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

the RefCountsRow to be removed
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

ToArray()

Number counter for all tables that generate numbers, e.g. templates, contacts... This table is used for the number allocation system and should not be confused with sequence, used for allocating internal ID's. This table is replicated during generation of satellites and during local update for travellers, using special logic. By default it contains rows for the SuperOffice standard counters, including one row for each DocTemplate record. It is permissible to add new rows to this table, and such records are maintainable through the Maintenance client. Changing the contents of the standard records is not recommended. Collection of RefCountsRow. Each element of the collection represents one row in the RefCounts table.

Declaration
public RefCountsRow[] ToArray()
Returns
Type Description
RefCountsRow[]
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
String
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 RefCountsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) RefCountsRows RefCountsRows.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(RefCountsRows.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 RefCountsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, RefCountsTableInfo) 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).

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)