Class SoapAccessRows

Table that contains constraints on the access to the soap interface Collection of SoapAccessRow. Each element of the collection represents one row in the SoapAccess table.

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

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

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

Methods

Add(SoapAccessRow)

Add one SoapAccessRow to the collection.

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

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

The index of the added SoapAccessRow.

AddNew()

Add a new instance of SoapAccessRow added to the collection.

Declaration
public SoapAccessRow AddNew()
Returns
Type Description
SoapAccessRow

A new instance of SoapAccessRow added to the collection.

AddRange(IEnumerable<SoapAccessRow>)

Add a range of SoapAccessRow to the collection.

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

The updated SoapAccessRows collection object.

CreateChild()

Create a new instance of SoapAccessRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SoapAccessRow
Overrides

CreateNew()

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

Declaration
public static SoapAccessRows CreateNew()
Returns
Type Description
SoapAccessRows

A new instance of the SoapAccessRows object.

Find(Predicate<SoapAccessRow>)

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

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

FindAll(Predicate<SoapAccessRow>)

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

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

ForEach(Action<SoapAccessRow>)

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

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

GetFromCustomSearch(SoapAccessRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, SoapAccessTableInfo)

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

SoDataReader positioned to a valid database row.
SoapAccessTableInfo tableInfo

SoapAccessTableInfo 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
SoapAccessRows

Remove(SoapAccessRow)

Removes the given SoapAccessRow from the collection

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

the SoapAccessRow to be removed

ToArray()

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

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)