Class KbEntryRows

This table contains FAQ entries. Collection of KbEntryRow. Each element of the collection represents one row in the KbEntry table.

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

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

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

Methods

Add(KbEntryRow)

Add one KbEntryRow to the collection.

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

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

The index of the added KbEntryRow.

AddNew()

Add a new instance of KbEntryRow added to the collection.

Declaration
public KbEntryRow AddNew()
Returns
Type Description
KbEntryRow

A new instance of KbEntryRow added to the collection.

AddRange(IEnumerable<KbEntryRow>)

Add a range of KbEntryRow to the collection.

Declaration
public KbEntryRows AddRange(IEnumerable<KbEntryRow> rows)
Parameters
Type Name Description
IEnumerable<KbEntryRow> rows
Returns
Type Description
KbEntryRows

The updated KbEntryRows collection object.

CreateChild()

Create a new instance of KbEntryRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of KbEntryRow
Overrides

CreateNew()

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

Declaration
public static KbEntryRows CreateNew()
Returns
Type Description
KbEntryRows

A new instance of the KbEntryRows object.

Find(Predicate<KbEntryRow>)

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

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

FindAll(Predicate<KbEntryRow>)

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

Declaration
public KbEntryRows FindAll(Predicate<KbEntryRow> condition)
Parameters
Type Name Description
Predicate<KbEntryRow> condition
Returns
Type Description
KbEntryRows

ForEach(Action<KbEntryRow>)

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

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

GetFromCustomSearch(KbEntryRows.CustomSearch)

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

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

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

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

GetFromIdxCategoryId(Int32)

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

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

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

GetFromIdxCreatedBy(Int32)

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

Declaration
public static KbEntryRows GetFromIdxCreatedBy(int createdBy)
Parameters
Type Name Description
Int32 createdBy
Returns
Type Description
KbEntryRows

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

GetFromIdxDbiAgentId(Int32)

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

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

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

GetFromIdxDbiKey(String)

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

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

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

GetFromIdxDbiLastModified(DateTime)

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

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

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

GetFromIdxDbiLastSyncronized(DateTime)

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

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

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

GetFromIdxSortOrder(Int32)

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

Declaration
public static KbEntryRows GetFromIdxSortOrder(int sortOrder)
Parameters
Type Name Description
Int32 sortOrder
Returns
Type Description
KbEntryRows

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

GetFromIdxTitle(String)

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

Declaration
public static KbEntryRows GetFromIdxTitle(string title)
Parameters
Type Name Description
String title
Returns
Type Description
KbEntryRows

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

GetFromIdxTitleQuestion(String, String)

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

Declaration
public static KbEntryRows GetFromIdxTitleQuestion(string title, string question)
Parameters
Type Name Description
String title
String question
Returns
Type Description
KbEntryRows

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

GetFromIdxTitleQuestionAnswer(String, String, String)

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

Declaration
public static KbEntryRows GetFromIdxTitleQuestionAnswer(string title, string question, string answer)
Parameters
Type Name Description
String title
String question
String answer
Returns
Type Description
KbEntryRows

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

GetFromIdxTitleQuestionAnswerKeywords(String, String, String, String)

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

Declaration
public static KbEntryRows GetFromIdxTitleQuestionAnswerKeywords(string title, string question, string answer, string keywords)
Parameters
Type Name Description
String title
String question
String answer
String keywords
Returns
Type Description
KbEntryRows

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

GetFromIdxWorkflowPhase(Int32)

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

Declaration
public static KbEntryRows GetFromIdxWorkflowPhase(int workflowPhase)
Parameters
Type Name Description
Int32 workflowPhase
Returns
Type Description
KbEntryRows

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

GetFromReader(SoDataReader, KbEntryTableInfo)

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

SoDataReader positioned to a valid database row.
KbEntryTableInfo tableInfo

KbEntryTableInfo 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
KbEntryRows

Remove(KbEntryRow)

Removes the given KbEntryRow from the collection

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

the KbEntryRow to be removed

ToArray()

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

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)