Class RoleCategoryRows

Category membership associated with a role Collection of RoleCategoryRow. Each element of the collection represents one row in the RoleCategory table.

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

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

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

Methods

Add(RoleCategoryRow)

Add one RoleCategoryRow to the collection.

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

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

The index of the added RoleCategoryRow.

AddNew()

Add a new instance of RoleCategoryRow added to the collection.

Declaration
public RoleCategoryRow AddNew()
Returns
Type Description
RoleCategoryRow

A new instance of RoleCategoryRow added to the collection.

AddRange(IEnumerable<RoleCategoryRow>)

Add a range of RoleCategoryRow to the collection.

Declaration
public RoleCategoryRows AddRange(IEnumerable<RoleCategoryRow> rows)
Parameters
Type Name Description
IEnumerable<RoleCategoryRow> rows
Returns
Type Description
RoleCategoryRows

The updated RoleCategoryRows collection object.

CreateChild()

Create a new instance of RoleCategoryRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of RoleCategoryRow
Overrides

CreateNew()

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

Declaration
public static RoleCategoryRows CreateNew()
Returns
Type Description
RoleCategoryRows

A new instance of the RoleCategoryRows object.

Find(Predicate<RoleCategoryRow>)

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

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

FindAll(Predicate<RoleCategoryRow>)

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

Declaration
public RoleCategoryRows FindAll(Predicate<RoleCategoryRow> condition)
Parameters
Type Name Description
Predicate<RoleCategoryRow> condition
Returns
Type Description
RoleCategoryRows

ForEach(Action<RoleCategoryRow>)

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

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

GetFromCustomSearch(RoleCategoryRows.CustomSearch)

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

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

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

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

GetFromIdxCategory(Int32)

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

Declaration
public static RoleCategoryRows GetFromIdxCategory(int category)
Parameters
Type Name Description
Int32 category
Returns
Type Description
RoleCategoryRows

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

GetFromIdxCrmRole(Int32)

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

Declaration
public static RoleCategoryRows GetFromIdxCrmRole(int crmRole)
Parameters
Type Name Description
Int32 crmRole
Returns
Type Description
RoleCategoryRows

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

GetFromIdxRole(Int32)

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

Declaration
public static RoleCategoryRows GetFromIdxRole(int role)
Parameters
Type Name Description
Int32 role
Returns
Type Description
RoleCategoryRows

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

GetFromReader(SoDataReader, RoleCategoryTableInfo)

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

SoDataReader positioned to a valid database row.
RoleCategoryTableInfo tableInfo

RoleCategoryTableInfo 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
RoleCategoryRows

Remove(RoleCategoryRow)

Removes the given RoleCategoryRow from the collection

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

the RoleCategoryRow to be removed

ToArray()

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

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)