Class SubscriptionUnitRows
The list of Subscription units, in the internal product register (year/quarter/month etc., or perhaps amounts if volume-based subscription) Collection of SubscriptionUnitRow. Each element of the collection represents one row in the SubscriptionUnit table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SubscriptionUnitRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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
this[int]
Get a SubscriptionUnitRow given its index in the collection.
Declaration
public SubscriptionUnitRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the SubscriptionUnitRow in the collection |
Property Value
Type | Description |
---|---|
SubscriptionUnitRow |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
Methods
Add(SubscriptionUnitRow)
Add one SubscriptionUnitRow to the collection.
Declaration
public int Add(SubscriptionUnitRow row)
Parameters
Type | Name | Description |
---|---|---|
SubscriptionUnitRow | row | An instance of SubscriptionUnitRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added SubscriptionUnitRow. |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
AddNew()
Add a new instance of SubscriptionUnitRow added to the collection.
Declaration
public SubscriptionUnitRow AddNew()
Returns
Type | Description |
---|---|
SubscriptionUnitRow | A new instance of SubscriptionUnitRow added to the collection. |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
AddRange(IEnumerable<SubscriptionUnitRow>)
Add a range of SubscriptionUnitRow to the collection.
Declaration
public SubscriptionUnitRows AddRange(IEnumerable<SubscriptionUnitRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<SubscriptionUnitRow> | rows |
Returns
Type | Description |
---|---|
SubscriptionUnitRows | The updated SubscriptionUnitRows collection object. |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
CreateChild()
Create a new instance of SubscriptionUnitRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of SubscriptionUnitRow |
Overrides
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
CreateNew()
Create a new instance of the SubscriptionUnitRows object. This collection will contain no rows.
Declaration
public static SubscriptionUnitRows CreateNew()
Returns
Type | Description |
---|---|
SubscriptionUnitRows | A new instance of the SubscriptionUnitRows object. |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
Find(Predicate<SubscriptionUnitRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public SubscriptionUnitRow Find(Predicate<SubscriptionUnitRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SubscriptionUnitRow> | condition |
Returns
Type | Description |
---|---|
SubscriptionUnitRow |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
FindAll(Predicate<SubscriptionUnitRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public SubscriptionUnitRows FindAll(Predicate<SubscriptionUnitRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SubscriptionUnitRow> | condition |
Returns
Type | Description |
---|---|
SubscriptionUnitRows |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
ForEach(Action<SubscriptionUnitRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<SubscriptionUnitRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<SubscriptionUnitRow> | whatToDo |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the SubscriptionUnitRows 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 SubscriptionUnitRow objects representing each row will be returned.
Declaration
public static SubscriptionUnitRows GetFromCustomSearch(SubscriptionUnitRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
SubscriptionUnitRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
SubscriptionUnitRows | A new instance of the SubscriptionUnitRows object, reflecting the result of the query. |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
GetFromReader(SoDataReader, SubscriptionUnitTableInfo)
Create a new instance of the SubscriptionUnitRows 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 SubscriptionUnitRow 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 SubscriptionUnitRows GetFromReader(SoDataReader reader, SubscriptionUnitTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
SubscriptionUnitTableInfo | tableInfo | SubscriptionUnitTableInfo 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 |
---|---|
SubscriptionUnitRows |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
Remove(SubscriptionUnitRow)
Removes the given SubscriptionUnitRow from the collection
Declaration
public void Remove(SubscriptionUnitRow row)
Parameters
Type | Name | Description |
---|---|---|
SubscriptionUnitRow | row | the SubscriptionUnitRow to be removed |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
ToArray()
The list of Subscription units, in the internal product register (year/quarter/month etc., or perhaps amounts if volume-based subscription) Collection of SubscriptionUnitRow. Each element of the collection represents one row in the SubscriptionUnit table.
Declaration
public SubscriptionUnitRow[] ToArray()
Returns
Type | Description |
---|---|
SubscriptionUnitRow[] |
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
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 SubscriptionUnitRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SubscriptionUnitRows SubscriptionUnitRows.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(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.