Class SystemEventRows
System events, such as freetext rebuild, SAINT rebuild and such. Makes broadcasts to keep its siblings and clients updated. Collection of SystemEventRow. Each element of the collection represents one row in the SystemEvent table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SystemEventRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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 SystemEventRow given its index in the collection.
Declaration
public SystemEventRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the SystemEventRow in the collection |
Property Value
| Type | Description |
|---|---|
| SystemEventRow |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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(SystemEventRow)
Add one SystemEventRow to the collection.
Declaration
public int Add(SystemEventRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| SystemEventRow | row | An instance of SystemEventRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added SystemEventRow. |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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 SystemEventRow added to the collection.
Declaration
public SystemEventRow AddNew()
Returns
| Type | Description |
|---|---|
| SystemEventRow | A new instance of SystemEventRow 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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<SystemEventRow>)
Add a range of SystemEventRow to the collection.
Declaration
public SystemEventRows AddRange(IEnumerable<SystemEventRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<SystemEventRow> | rows |
Returns
| Type | Description |
|---|---|
| SystemEventRows | The updated SystemEventRows 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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 SystemEventRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of SystemEventRow |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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 SystemEventRows object. This collection will contain no rows.
Declaration
public static SystemEventRows CreateNew()
Returns
| Type | Description |
|---|---|
| SystemEventRows | A new instance of the SystemEventRows 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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<SystemEventRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public SystemEventRow Find(Predicate<SystemEventRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<SystemEventRow> | condition |
Returns
| Type | Description |
|---|---|
| SystemEventRow |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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<SystemEventRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public SystemEventRows FindAll(Predicate<SystemEventRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<SystemEventRow> | condition |
Returns
| Type | Description |
|---|---|
| SystemEventRows |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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<SystemEventRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<SystemEventRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<SystemEventRow> | 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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.
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the SystemEventRows 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 SystemEventRow objects representing each row will be returned.
Declaration
public static Task<SystemEventRows> GetFromCustomSearchAsync(SystemEventRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SystemEventRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SystemEventRows> | A new instance of the SystemEventRows 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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.
GetFromIdxEventkeyAsync(string, CancellationToken)
Create a new instance of the SystemEventRow object, by querying the database table via the index 'IEventkeyScopeOwner'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<SystemEventRows> GetFromIdxEventkeyAsync(string eventkey, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | eventkey | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SystemEventRows> | Row object that represents the result of the search. IsNew 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 SystemEvent table. Non-unique indexes have corresponding inner classes and methods in the SystemEventRows collection, since they may return more than one row.
GetFromIdxEventkeyScopeAsync(string, int, CancellationToken)
Create a new instance of the SystemEventRow object, by querying the database table via the index 'IEventkeyScopeOwner'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<SystemEventRows> GetFromIdxEventkeyScopeAsync(string eventkey, int scope, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | eventkey | |
| int | scope | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SystemEventRows> | Row object that represents the result of the search. IsNew 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 SystemEvent table. Non-unique indexes have corresponding inner classes and methods in the SystemEventRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, SystemEventTableInfo, CancellationToken)
Create a new instance of the SystemEventRows 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 SystemEventRow 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 Task<SystemEventRows> GetFromReaderAsync(SoDataReader reader, SystemEventTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| SystemEventTableInfo | tableInfo | SystemEventTableInfo 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. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SystemEventRows> |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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(SystemEventRow)
Removes the given SystemEventRow from the collection
Declaration
public void Remove(SystemEventRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| SystemEventRow | row | the SystemEventRow 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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()
System events, such as freetext rebuild, SAINT rebuild and such. Makes broadcasts to keep its siblings and clients updated. Collection of SystemEventRow. Each element of the collection represents one row in the SystemEvent table.
Declaration
public SystemEventRow[] ToArray()
Returns
| Type | Description |
|---|---|
| SystemEventRow[] |
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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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 SystemEventRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) SystemEventRows SystemEventRows.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 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.