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