Class RecurrenceRuleRows

The recurrency pattern for a recurring event. Each recurring event has an appointment.recurrenceRuleId pointing to its pattern. Collection of RecurrenceRuleRow. Each element of the collection represents one row in the RecurrenceRule table.

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

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

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

Methods

Add(RecurrenceRuleRow)

Add one RecurrenceRuleRow to the collection.

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

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

The index of the added RecurrenceRuleRow.

AddNew()

Add a new instance of RecurrenceRuleRow added to the collection.

Declaration
public RecurrenceRuleRow AddNew()
Returns
Type Description
RecurrenceRuleRow

A new instance of RecurrenceRuleRow added to the collection.

AddRange(IEnumerable<RecurrenceRuleRow>)

Add a range of RecurrenceRuleRow to the collection.

Declaration
public RecurrenceRuleRows AddRange(IEnumerable<RecurrenceRuleRow> rows)
Parameters
Type Name Description
IEnumerable<RecurrenceRuleRow> rows
Returns
Type Description
RecurrenceRuleRows

The updated RecurrenceRuleRows collection object.

CreateChild()

Create a new instance of RecurrenceRuleRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of RecurrenceRuleRow
Overrides

CreateNew()

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

Declaration
public static RecurrenceRuleRows CreateNew()
Returns
Type Description
RecurrenceRuleRows

A new instance of the RecurrenceRuleRows object.

Find(Predicate<RecurrenceRuleRow>)

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

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

FindAll(Predicate<RecurrenceRuleRow>)

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

Declaration
public RecurrenceRuleRows FindAll(Predicate<RecurrenceRuleRow> condition)
Parameters
Type Name Description
Predicate<RecurrenceRuleRow> condition
Returns
Type Description
RecurrenceRuleRows

ForEach(Action<RecurrenceRuleRow>)

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

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

GetFromCustomSearch(RecurrenceRuleRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, RecurrenceRuleTableInfo)

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

SoDataReader positioned to a valid database row.
RecurrenceRuleTableInfo tableInfo

RecurrenceRuleTableInfo 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
RecurrenceRuleRows

Remove(RecurrenceRuleRow)

Removes the given RecurrenceRuleRow from the collection

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

the RecurrenceRuleRow to be removed

ToArray()

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

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)