Class RefCountRangeRows
Number allocation system, for keeping track of ranges of numbers loaned out to travel and satellite databases Collection of RefCountRangeRow. Each element of the collection represents one row in the RefCountRange table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class RefCountRangeRows : 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
RefCountRangeRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) RefCountRangeRows RefCountRangeRows.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(RefCountRangeRows.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.
Properties
Item[Int32]
Get a RefCountRangeRow given its index in the collection.
Declaration
public RefCountRangeRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Index of the RefCountRangeRow in the collection |
Property Value
Type | Description |
---|---|
RefCountRangeRow |
Methods
Add(RefCountRangeRow)
Add one RefCountRangeRow to the collection.
Declaration
public int Add(RefCountRangeRow row)
Parameters
Type | Name | Description |
---|---|---|
RefCountRangeRow | row | An instance of RefCountRangeRow to be added to the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the added RefCountRangeRow. |
AddNew()
Add a new instance of RefCountRangeRow added to the collection.
Declaration
public RefCountRangeRow AddNew()
Returns
Type | Description |
---|---|
RefCountRangeRow | A new instance of RefCountRangeRow added to the collection. |
AddRange(IEnumerable<RefCountRangeRow>)
Add a range of RefCountRangeRow to the collection.
Declaration
public RefCountRangeRows AddRange(IEnumerable<RefCountRangeRow> rows)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<RefCountRangeRow> | rows |
Returns
Type | Description |
---|---|
RefCountRangeRows | The updated RefCountRangeRows collection object. |
CreateChild()
Create a new instance of RefCountRangeRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of RefCountRangeRow |
Overrides
CreateNew()
Create a new instance of the RefCountRangeRows object. This collection will contain no rows.
Declaration
public static RefCountRangeRows CreateNew()
Returns
Type | Description |
---|---|
RefCountRangeRows | A new instance of the RefCountRangeRows object. |
Find(Predicate<RefCountRangeRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public RefCountRangeRow Find(Predicate<RefCountRangeRow> condition)
Parameters
Type | Name | Description |
---|---|---|
System.Predicate<RefCountRangeRow> | condition |
Returns
Type | Description |
---|---|
RefCountRangeRow |
FindAll(Predicate<RefCountRangeRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public RefCountRangeRows FindAll(Predicate<RefCountRangeRow> condition)
Parameters
Type | Name | Description |
---|---|---|
System.Predicate<RefCountRangeRow> | condition |
Returns
Type | Description |
---|---|
RefCountRangeRows |
ForEach(Action<RefCountRangeRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<RefCountRangeRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
System.Action<RefCountRangeRow> | whatToDo |
GetFromCustomSearch(RefCountRangeRows.CustomSearch)
Create a new instance of the RefCountRangeRows 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 RefCountRangeRow objects representing each row will be returned.
Declaration
public static RefCountRangeRows GetFromCustomSearch(RefCountRangeRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
RefCountRangeRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
RefCountRangeRows | A new instance of the RefCountRangeRows object, reflecting the result of the query. |
GetFromIdxRefCountsId(Int32)
Create a new instance of the RefCountRangeRow object, by querying the database table via the index 'IDXRefCountRangeRefCounts_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static RefCountRangeRows GetFromIdxRefCountsId(int refCountsId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | refCountsId |
Returns
Type | Description |
---|---|
RefCountRangeRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the RefCountRange table. Non-unique indexes have corresponding inner classes and methods in the RefCountRangeRows collection, since they may return more than one row.
GetFromIdxTravellerId(Int16)
Create a new instance of the RefCountRangeRow object, by querying the database table via the index 'IDXRefCountRangeTraveller_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static RefCountRangeRows GetFromIdxTravellerId(short travellerId)
Parameters
Type | Name | Description |
---|---|---|
System.Int16 | travellerId |
Returns
Type | Description |
---|---|
RefCountRangeRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the RefCountRange table. Non-unique indexes have corresponding inner classes and methods in the RefCountRangeRows collection, since they may return more than one row.
GetFromReader(SoDataReader, RefCountRangeTableInfo)
Create a new instance of the RefCountRangeRows 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 RefCountRangeRow 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 RefCountRangeRows GetFromReader(SoDataReader reader, RefCountRangeTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
RefCountRangeTableInfo | tableInfo | RefCountRangeTableInfo 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 |
---|---|
RefCountRangeRows |
Remove(RefCountRangeRow)
Removes the given RefCountRangeRow from the collection
Declaration
public void Remove(RefCountRangeRow row)
Parameters
Type | Name | Description |
---|---|---|
RefCountRangeRow | row | the RefCountRangeRow to be removed |
ToArray()
Declaration
public RefCountRangeRow[] ToArray()
Returns
Type | Description |
---|---|
RefCountRangeRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String |