Class DbiAgentScheduleRows

DBI agent schedule settings Collection of DbiAgentScheduleRow. Each element of the collection represents one row in the DbiAgentSchedule table.

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

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

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

Methods

Add(DbiAgentScheduleRow)

Add one DbiAgentScheduleRow to the collection.

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

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

The index of the added DbiAgentScheduleRow.

AddNew()

Add a new instance of DbiAgentScheduleRow added to the collection.

Declaration
public DbiAgentScheduleRow AddNew()
Returns
Type Description
DbiAgentScheduleRow

A new instance of DbiAgentScheduleRow added to the collection.

AddRange(IEnumerable<DbiAgentScheduleRow>)

Add a range of DbiAgentScheduleRow to the collection.

Declaration
public DbiAgentScheduleRows AddRange(IEnumerable<DbiAgentScheduleRow> rows)
Parameters
Type Name Description
IEnumerable<DbiAgentScheduleRow> rows
Returns
Type Description
DbiAgentScheduleRows

The updated DbiAgentScheduleRows collection object.

CreateChild()

Create a new instance of DbiAgentScheduleRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of DbiAgentScheduleRow
Overrides

CreateNew()

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

Declaration
public static DbiAgentScheduleRows CreateNew()
Returns
Type Description
DbiAgentScheduleRows

A new instance of the DbiAgentScheduleRows object.

Find(Predicate<DbiAgentScheduleRow>)

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

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

FindAll(Predicate<DbiAgentScheduleRow>)

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

Declaration
public DbiAgentScheduleRows FindAll(Predicate<DbiAgentScheduleRow> condition)
Parameters
Type Name Description
Predicate<DbiAgentScheduleRow> condition
Returns
Type Description
DbiAgentScheduleRows

ForEach(Action<DbiAgentScheduleRow>)

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

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

GetFromCustomSearch(DbiAgentScheduleRows.CustomSearch)

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

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

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

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

GetFromIdxAgentId(Int32)

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

Declaration
public static DbiAgentScheduleRows GetFromIdxAgentId(int agentId)
Parameters
Type Name Description
Int32 agentId
Returns
Type Description
DbiAgentScheduleRows

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

GetFromIdxScheduleId(Int32)

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

Declaration
public static DbiAgentScheduleRows GetFromIdxScheduleId(int scheduleId)
Parameters
Type Name Description
Int32 scheduleId
Returns
Type Description
DbiAgentScheduleRows

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

GetFromIdxScriptId(Int32)

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

Declaration
public static DbiAgentScheduleRows GetFromIdxScriptId(int scriptId)
Parameters
Type Name Description
Int32 scriptId
Returns
Type Description
DbiAgentScheduleRows

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

GetFromReader(SoDataReader, DbiAgentScheduleTableInfo)

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

SoDataReader positioned to a valid database row.
DbiAgentScheduleTableInfo tableInfo

DbiAgentScheduleTableInfo 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
DbiAgentScheduleRows

Remove(DbiAgentScheduleRow)

Removes the given DbiAgentScheduleRow from the collection

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

the DbiAgentScheduleRow to be removed

ToArray()

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

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)