Class CategoryMembershipRows

This table connects users to categories (many-to-many). Collection of CategoryMembershipRow. Each element of the collection represents one row in the CategoryMembership table.

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

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

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

Methods

Add(CategoryMembershipRow)

Add one CategoryMembershipRow to the collection.

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

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

The index of the added CategoryMembershipRow.

AddNew()

Add a new instance of CategoryMembershipRow added to the collection.

Declaration
public CategoryMembershipRow AddNew()
Returns
Type Description
CategoryMembershipRow

A new instance of CategoryMembershipRow added to the collection.

AddRange(IEnumerable<CategoryMembershipRow>)

Add a range of CategoryMembershipRow to the collection.

Declaration
public CategoryMembershipRows AddRange(IEnumerable<CategoryMembershipRow> rows)
Parameters
Type Name Description
IEnumerable<CategoryMembershipRow> rows
Returns
Type Description
CategoryMembershipRows

The updated CategoryMembershipRows collection object.

CreateChild()

Create a new instance of CategoryMembershipRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CategoryMembershipRow
Overrides

CreateNew()

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

Declaration
public static CategoryMembershipRows CreateNew()
Returns
Type Description
CategoryMembershipRows

A new instance of the CategoryMembershipRows object.

Find(Predicate<CategoryMembershipRow>)

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

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

FindAll(Predicate<CategoryMembershipRow>)

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

Declaration
public CategoryMembershipRows FindAll(Predicate<CategoryMembershipRow> condition)
Parameters
Type Name Description
Predicate<CategoryMembershipRow> condition
Returns
Type Description
CategoryMembershipRows

ForEach(Action<CategoryMembershipRow>)

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

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

GetFromCustomSearch(CategoryMembershipRows.CustomSearch)

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

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

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

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

GetFromIdxCategoryId(Int32)

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

Declaration
public static CategoryMembershipRows GetFromIdxCategoryId(int categoryId)
Parameters
Type Name Description
Int32 categoryId
Returns
Type Description
CategoryMembershipRows

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

GetFromIdxUserId(Int32)

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

Declaration
public static CategoryMembershipRows GetFromIdxUserId(int userId)
Parameters
Type Name Description
Int32 userId
Returns
Type Description
CategoryMembershipRows

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

GetFromReader(SoDataReader, CategoryMembershipTableInfo)

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

SoDataReader positioned to a valid database row.
CategoryMembershipTableInfo tableInfo

CategoryMembershipTableInfo 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
CategoryMembershipRows

Remove(CategoryMembershipRow)

Removes the given CategoryMembershipRow from the collection

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

the CategoryMembershipRow to be removed

ToArray()

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

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)