Class SOROperatorsRows

SuperOffice reporter data Collection of SOROperatorsRow. Each element of the collection represents one row in the SOROperators table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SOROperatorsRows
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 SOROperatorsRows : 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 SOROperatorsRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) SOROperatorsRows SOROperatorsRows.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(SOROperatorsRows.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 SOROperatorsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SOROperatorsTableInfo) 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 SOROperatorsRow given its index in the collection.

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

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

Methods

Add(SOROperatorsRow)

Add one SOROperatorsRow to the collection.

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

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

The index of the added SOROperatorsRow.

AddNew()

Add a new instance of SOROperatorsRow added to the collection.

Declaration
public SOROperatorsRow AddNew()
Returns
Type Description
SOROperatorsRow

A new instance of SOROperatorsRow added to the collection.

AddRange(IEnumerable<SOROperatorsRow>)

Add a range of SOROperatorsRow to the collection.

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

The updated SOROperatorsRows collection object.

CreateChild()

Create a new instance of SOROperatorsRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SOROperatorsRow
Overrides

CreateNew()

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

Declaration
public static SOROperatorsRows CreateNew()
Returns
Type Description
SOROperatorsRows

A new instance of the SOROperatorsRows object.

Find(Predicate<SOROperatorsRow>)

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

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

FindAll(Predicate<SOROperatorsRow>)

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

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

ForEach(Action<SOROperatorsRow>)

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

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

GetFromCustomSearch(SOROperatorsRows.CustomSearch)

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

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

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

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

GetFromIdxOperatorType(String)

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

Declaration
public static SOROperatorsRows GetFromIdxOperatorType(string operatorType)
Parameters
Type Name Description
System.String operatorType
Returns
Type Description
SOROperatorsRows

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

GetFromReader(SoDataReader, SOROperatorsTableInfo)

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

SoDataReader positioned to a valid database row.
SOROperatorsTableInfo tableInfo

SOROperatorsTableInfo 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
SOROperatorsRows

Remove(SOROperatorsRow)

Removes the given SOROperatorsRow from the collection

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

the SOROperatorsRow to be removed

ToArray()

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

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)