Class TemporaryKeyRows
Temporary keys for lightweight authentications such as changing ones subscriptions Collection of TemporaryKeyRow. Each element of the collection represents one row in the TemporaryKey table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class TemporaryKeyRows : 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRow given its index in the collection.
Declaration
public TemporaryKeyRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the TemporaryKeyRow in the collection |
Property Value
Type | Description |
---|---|
TemporaryKeyRow |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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(TemporaryKeyRow)
Add one TemporaryKeyRow to the collection.
Declaration
public int Add(TemporaryKeyRow row)
Parameters
Type | Name | Description |
---|---|---|
TemporaryKeyRow | row | An instance of TemporaryKeyRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added TemporaryKeyRow. |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRow added to the collection.
Declaration
public TemporaryKeyRow AddNew()
Returns
Type | Description |
---|---|
TemporaryKeyRow | A new instance of TemporaryKeyRow 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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<TemporaryKeyRow>)
Add a range of TemporaryKeyRow to the collection.
Declaration
public TemporaryKeyRows AddRange(IEnumerable<TemporaryKeyRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<TemporaryKeyRow> | rows |
Returns
Type | Description |
---|---|
TemporaryKeyRows | The updated TemporaryKeyRows 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of TemporaryKeyRow |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRows object. This collection will contain no rows.
Declaration
public static TemporaryKeyRows CreateNew()
Returns
Type | Description |
---|---|
TemporaryKeyRows | A new instance of the TemporaryKeyRows 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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<TemporaryKeyRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public TemporaryKeyRow Find(Predicate<TemporaryKeyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<TemporaryKeyRow> | condition |
Returns
Type | Description |
---|---|
TemporaryKeyRow |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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<TemporaryKeyRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public TemporaryKeyRows FindAll(Predicate<TemporaryKeyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<TemporaryKeyRow> | condition |
Returns
Type | Description |
---|---|
TemporaryKeyRows |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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<TemporaryKeyRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<TemporaryKeyRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<TemporaryKeyRow> | 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRows 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 TemporaryKeyRow objects representing each row will be returned.
Declaration
public static TemporaryKeyRows GetFromCustomSearch(TemporaryKeyRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
TemporaryKeyRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
TemporaryKeyRows | A new instance of the TemporaryKeyRows 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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, TemporaryKeyTableInfo)
Create a new instance of the TemporaryKeyRows 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 TemporaryKeyRow 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 TemporaryKeyRows GetFromReader(SoDataReader reader, TemporaryKeyTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
TemporaryKeyTableInfo | tableInfo | TemporaryKeyTableInfo 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 |
---|---|
TemporaryKeyRows |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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(TemporaryKeyRow)
Removes the given TemporaryKeyRow from the collection
Declaration
public void Remove(TemporaryKeyRow row)
Parameters
Type | Name | Description |
---|---|---|
TemporaryKeyRow | row | the TemporaryKeyRow 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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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()
Temporary keys for lightweight authentications such as changing ones subscriptions Collection of TemporaryKeyRow. Each element of the collection represents one row in the TemporaryKey table.
Declaration
public TemporaryKeyRow[] ToArray()
Returns
Type | Description |
---|---|
TemporaryKeyRow[] |
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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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 TemporaryKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) TemporaryKeyRows TemporaryKeyRows.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.