Class DataRightRows

Data right definition Collection of DataRightRow. Each element of the collection represents one row in the DataRight table.

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

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

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

Methods

Add(DataRightRow)

Add one DataRightRow to the collection.

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

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

The index of the added DataRightRow.

AddNew()

Add a new instance of DataRightRow added to the collection.

Declaration
public DataRightRow AddNew()
Returns
Type Description
DataRightRow

A new instance of DataRightRow added to the collection.

AddRange(IEnumerable<DataRightRow>)

Add a range of DataRightRow to the collection.

Declaration
public DataRightRows AddRange(IEnumerable<DataRightRow> rows)
Parameters
Type Name Description
IEnumerable<DataRightRow> rows
Returns
Type Description
DataRightRows

The updated DataRightRows collection object.

CreateChild()

Create a new instance of DataRightRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of DataRightRow
Overrides

CreateNew()

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

Declaration
public static DataRightRows CreateNew()
Returns
Type Description
DataRightRows

A new instance of the DataRightRows object.

Find(Predicate<DataRightRow>)

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

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

FindAll(Predicate<DataRightRow>)

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

Declaration
public DataRightRows FindAll(Predicate<DataRightRow> condition)
Parameters
Type Name Description
Predicate<DataRightRow> condition
Returns
Type Description
DataRightRows

ForEach(Action<DataRightRow>)

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

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

GetFromCustomSearch(DataRightRows.CustomSearch)

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

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

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

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

GetFromIdxRoleId(Int32)

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

Declaration
public static DataRightRows GetFromIdxRoleId(int roleId)
Parameters
Type Name Description
Int32 roleId
Returns
Type Description
DataRightRows

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

GetFromIdxRoleIdTableId(Int32, Int16)

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

Declaration
public static DataRightRows GetFromIdxRoleIdTableId(int roleId, short tableId)
Parameters
Type Name Description
Int32 roleId
Int16 tableId
Returns
Type Description
DataRightRows

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

GetFromIdxRoleIdTableIdFieldId(Int32, Int16, Int32)

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

Declaration
public static DataRightRows GetFromIdxRoleIdTableIdFieldId(int roleId, short tableId, int fieldId)
Parameters
Type Name Description
Int32 roleId
Int16 tableId
Int32 fieldId
Returns
Type Description
DataRightRows

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

GetFromReader(SoDataReader, DataRightTableInfo)

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

SoDataReader positioned to a valid database row.
DataRightTableInfo tableInfo

DataRightTableInfo 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
DataRightRows

Remove(DataRightRow)

Removes the given DataRightRow from the collection

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

the DataRightRow to be removed

ToArray()

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

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

EnumUtil.MapEnums<From, To>(From)