Class KbGroupRows

This table contains FAQ groups. A group is a cluster of entries (potentially located anywhere in the FAQ hierarchy). A group is located in a certain category. Collection of KbGroupRow. Each element of the collection represents one row in the KbGroup table.

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

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

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

Methods

Add(KbGroupRow)

Add one KbGroupRow to the collection.

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

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

The index of the added KbGroupRow.

AddNew()

Add a new instance of KbGroupRow added to the collection.

Declaration
public KbGroupRow AddNew()
Returns
Type Description
KbGroupRow

A new instance of KbGroupRow added to the collection.

AddRange(IEnumerable<KbGroupRow>)

Add a range of KbGroupRow to the collection.

Declaration
public KbGroupRows AddRange(IEnumerable<KbGroupRow> rows)
Parameters
Type Name Description
IEnumerable<KbGroupRow> rows
Returns
Type Description
KbGroupRows

The updated KbGroupRows collection object.

CreateChild()

Create a new instance of KbGroupRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of KbGroupRow
Overrides

CreateNew()

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

Declaration
public static KbGroupRows CreateNew()
Returns
Type Description
KbGroupRows

A new instance of the KbGroupRows object.

Find(Predicate<KbGroupRow>)

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

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

FindAll(Predicate<KbGroupRow>)

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

Declaration
public KbGroupRows FindAll(Predicate<KbGroupRow> condition)
Parameters
Type Name Description
Predicate<KbGroupRow> condition
Returns
Type Description
KbGroupRows

ForEach(Action<KbGroupRow>)

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

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

GetFromCustomSearch(KbGroupRows.CustomSearch)

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

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

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

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

GetFromIdxDbiAgentId(Int32)

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

Declaration
public static KbGroupRows GetFromIdxDbiAgentId(int dbiAgentId)
Parameters
Type Name Description
Int32 dbiAgentId
Returns
Type Description
KbGroupRows

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

GetFromIdxDbiKey(String)

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

Declaration
public static KbGroupRows GetFromIdxDbiKey(string dbiKey)
Parameters
Type Name Description
String dbiKey
Returns
Type Description
KbGroupRows

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

GetFromIdxDbiLastModified(DateTime)

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

Declaration
public static KbGroupRows GetFromIdxDbiLastModified(DateTime dbiLastModified)
Parameters
Type Name Description
DateTime dbiLastModified
Returns
Type Description
KbGroupRows

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

GetFromIdxDbiLastSyncronized(DateTime)

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

Declaration
public static KbGroupRows GetFromIdxDbiLastSyncronized(DateTime dbiLastSyncronized)
Parameters
Type Name Description
DateTime dbiLastSyncronized
Returns
Type Description
KbGroupRows

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

GetFromIdxKbCategoryId(Int32)

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

Declaration
public static KbGroupRows GetFromIdxKbCategoryId(int kbCategoryId)
Parameters
Type Name Description
Int32 kbCategoryId
Returns
Type Description
KbGroupRows

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

GetFromIdxParentId(Int32)

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

Declaration
public static KbGroupRows GetFromIdxParentId(int parentId)
Parameters
Type Name Description
Int32 parentId
Returns
Type Description
KbGroupRows

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

GetFromReader(SoDataReader, KbGroupTableInfo)

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

SoDataReader positioned to a valid database row.
KbGroupTableInfo tableInfo

KbGroupTableInfo 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
KbGroupRows

Remove(KbGroupRow)

Removes the given KbGroupRow from the collection

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

the KbGroupRow to be removed

ToArray()

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

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)