Class KbWorkflowRows

public class KbWorkflowRows : 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 KbWorkflowRow to it, and use methods like to operate on the whole collection.
You can create a (nested) KbWorkflowRows KbWorkflowRows.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(KbWorkflowRows.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 KbWorkflowRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, KbWorkflowTableInfo) 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 KbWorkflowRow given its index in the collection.

Declaration

public KbWorkflowRow this[int index] { get; }

Parameters

Type	Name	Description
Int32	index	Index of the KbWorkflowRow in the collection

Property Value

Type	Description
KbWorkflowRow

Methods

Add(KbWorkflowRow)

Add one KbWorkflowRow to the collection.

Declaration

public int Add(KbWorkflowRow row)

Parameters

Type	Name	Description
KbWorkflowRow	row	An instance of KbWorkflowRow to be added to the collection.

Returns

Type	Description
Int32	The index of the added KbWorkflowRow.

AddNew()

Add a new instance of KbWorkflowRow added to the collection.

Declaration

public KbWorkflowRow AddNew()

Returns

Type	Description
KbWorkflowRow	A new instance of KbWorkflowRow added to the collection.

AddRange(IEnumerable<KbWorkflowRow>)

Add a range of KbWorkflowRow to the collection.

Declaration

public KbWorkflowRows AddRange(IEnumerable<KbWorkflowRow> rows)

Parameters

Type	Name	Description
IEnumerable<KbWorkflowRow>	rows

Returns

Type	Description
KbWorkflowRows	The updated KbWorkflowRows collection object.

CreateChild()

Create a new instance of KbWorkflowRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of KbWorkflowRow

Overrides

TableRowsBase.CreateChild()

CreateNew()

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

Declaration

public static KbWorkflowRows CreateNew()

Returns

Type	Description
KbWorkflowRows	A new instance of the KbWorkflowRows object.

Find(Predicate<KbWorkflowRow>)

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

Declaration

public KbWorkflowRow Find(Predicate<KbWorkflowRow> condition)

Parameters

Type	Name	Description
Predicate<KbWorkflowRow>	condition

Returns

Type	Description
KbWorkflowRow

FindAll(Predicate<KbWorkflowRow>)

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

Declaration

public KbWorkflowRows FindAll(Predicate<KbWorkflowRow> condition)

Parameters

Type	Name	Description
Predicate<KbWorkflowRow>	condition

Returns

Type	Description
KbWorkflowRows

ForEach(Action<KbWorkflowRow>)

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

Declaration

public void ForEach(Action<KbWorkflowRow> whatToDo)

Parameters

Type	Name	Description
Action<KbWorkflowRow>	whatToDo

GetFromCustomSearch(KbWorkflowRows.CustomSearch)

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

Declaration

public static KbWorkflowRows GetFromCustomSearch(KbWorkflowRows.CustomSearch query)

Parameters

Type	Name	Description
KbWorkflowRows.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
KbWorkflowRows	A new instance of the KbWorkflowRows object, reflecting the result of the query.

GetFromIdxNext(Int32)

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

Declaration

public static KbWorkflowRows GetFromIdxNext(int next)

Parameters

Type	Name	Description
Int32	next

Returns

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

GetFromIdxPrevious(Int32)

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

Declaration

public static KbWorkflowRows GetFromIdxPrevious(int previous)

Parameters

Type	Name	Description
Int32	previous

Returns

Type	Description
KbWorkflowRows	Row object that represents the result of the search. will be true if the query did not match any row in the table

Remarks

GetFromReader(SoDataReader, KbWorkflowTableInfo)

Create a new instance of the KbWorkflowRows 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 KbWorkflowRow 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 KbWorkflowRows GetFromReader(SoDataReader reader, KbWorkflowTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
KbWorkflowTableInfo	tableInfo	KbWorkflowTableInfo 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.