Class WorkflowGoalRows
A set of goals related to a workflow. Some goals will have search criterias associated with it to determine if the goal has been reached. Collection of WorkflowGoalRow. Each element of the collection represents one row in the WorkflowGoal table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class WorkflowGoalRows : 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRow given its index in the collection.
Declaration
public WorkflowGoalRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the WorkflowGoalRow in the collection |
Property Value
| Type | Description |
|---|---|
| WorkflowGoalRow |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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(WorkflowGoalRow)
Add one WorkflowGoalRow to the collection.
Declaration
public int Add(WorkflowGoalRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| WorkflowGoalRow | row | An instance of WorkflowGoalRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added WorkflowGoalRow. |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRow added to the collection.
Declaration
public WorkflowGoalRow AddNew()
Returns
| Type | Description |
|---|---|
| WorkflowGoalRow | A new instance of WorkflowGoalRow 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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<WorkflowGoalRow>)
Add a range of WorkflowGoalRow to the collection.
Declaration
public WorkflowGoalRows AddRange(IEnumerable<WorkflowGoalRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<WorkflowGoalRow> | rows |
Returns
| Type | Description |
|---|---|
| WorkflowGoalRows | The updated WorkflowGoalRows 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of WorkflowGoalRow |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRows object. This collection will contain no rows.
Declaration
public static WorkflowGoalRows CreateNew()
Returns
| Type | Description |
|---|---|
| WorkflowGoalRows | A new instance of the WorkflowGoalRows 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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<WorkflowGoalRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public WorkflowGoalRow Find(Predicate<WorkflowGoalRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WorkflowGoalRow> | condition |
Returns
| Type | Description |
|---|---|
| WorkflowGoalRow |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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<WorkflowGoalRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public WorkflowGoalRows FindAll(Predicate<WorkflowGoalRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WorkflowGoalRow> | condition |
Returns
| Type | Description |
|---|---|
| WorkflowGoalRows |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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<WorkflowGoalRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<WorkflowGoalRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<WorkflowGoalRow> | 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRows 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 WorkflowGoalRow objects representing each row will be returned.
Declaration
public static Task<WorkflowGoalRows> GetFromCustomSearchAsync(WorkflowGoalRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| WorkflowGoalRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<WorkflowGoalRows> | A new instance of the WorkflowGoalRows 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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.
GetFromReaderAsync(SoDataReader, WorkflowGoalTableInfo, CancellationToken)
Create a new instance of the WorkflowGoalRows 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 WorkflowGoalRow 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<WorkflowGoalRows> GetFromReaderAsync(SoDataReader reader, WorkflowGoalTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| WorkflowGoalTableInfo | tableInfo | WorkflowGoalTableInfo 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<WorkflowGoalRows> |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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(WorkflowGoalRow)
Removes the given WorkflowGoalRow from the collection
Declaration
public void Remove(WorkflowGoalRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| WorkflowGoalRow | row | the WorkflowGoalRow 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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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()
A set of goals related to a workflow. Some goals will have search criterias associated with it to determine if the goal has been reached. Collection of WorkflowGoalRow. Each element of the collection represents one row in the WorkflowGoal table.
Declaration
public WorkflowGoalRow[] ToArray()
Returns
| Type | Description |
|---|---|
| WorkflowGoalRow[] |
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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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 WorkflowGoalRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WorkflowGoalRows WorkflowGoalRows.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.