Class TicketListProvider
Provider for selecting a ticket.
Supported additionalInfo:
nameformat=includePersonAndCompany or nameformat=includeTicketId indicates how to format item name. If not specified, includePersonAndCompany is used.
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("Ticket")]
[MDOAdditionalInfo("nameformat", "Indicates how to format item name", "includePersonAndCompany")]
public class TicketListProvider : AnyTableListProviderBase, ISoListProvider, ISoListRemarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
Examples
Example of using AdditionalInfo:
"nameformat=includeTicketId"Constructors
TicketListProvider()
Provider for selecting a ticket.
Supported additionalInfo:
nameformat=includePersonAndCompany or nameformat=includeTicketId indicates how to format item name. If not specified, includePersonAndCompany is used.
Declaration
public TicketListProvider()Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
Examples
Example of using AdditionalInfo:
"nameformat=includeTicketId"Fields
ProviderName
Provider for selecting a ticket.
Supported additionalInfo:
nameformat=includePersonAndCompany or nameformat=includeTicketId indicates how to format item name. If not specified, includePersonAndCompany is used.
Declaration
public const string ProviderName = "Ticket"Field Value
| Type | Description |
|---|---|
| string |
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
Examples
Example of using AdditionalInfo:
"nameformat=includeTicketId"Properties
TableInfo
The main table info of the query. This is used by subclasses (e.g. this class) when restricting history data.
Declaration
protected override TableInfo TableInfo { get; }Property Value
| Type | Description |
|---|---|
| TableInfo |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
Methods
BuildSearchFromSubSearches(string)
Provider for selecting a ticket.
Supported additionalInfo:
nameformat=includePersonAndCompany or nameformat=includeTicketId indicates how to format item name. If not specified, includePersonAndCompany is used.
Declaration
protected Restriction BuildSearchFromSubSearches(string searchValue)Parameters
| Type | Name | Description |
|---|---|---|
| string | searchValue |
Returns
| Type | Description |
|---|---|
| Restriction |
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
Examples
Example of using AdditionalInfo:
"nameformat=includeTicketId"GetMainQueryAsync(CancellationToken)
Get the main query for the list.
Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<Select> |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
GetRootItemsAsync()
Get all the root items from the database
Declaration
protected override Task<List<ISoListItem>> GetRootItemsAsync()Returns
| Type | Description |
|---|---|
| Task<List<ISoListItem>> | History items. |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
InitAsync(CancellationToken)
Initiate the provider after the ConstructAsync(string, string, int[], bool, string, bool, CancellationToken) method is called.
Declaration
protected override Task InitAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
OnRead(SoDataReader, short)
Raised every time a new row has been read from the database.
The implementation should read tthe results from the reader
and populate an object implementing ISoListItem.
Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | Reader to reaf from. |
| short | lastRank | Value of the last rank populated. |
Returns
| Type | Description |
|---|---|
| ISoListItem | Data read from the reader. |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.
SetSearchRestrictionAsync(Select, string)
Set the search restriction on the list.
Declaration
protected override Task SetSearchRestrictionAsync(Select sql, string searchValue)Parameters
| Type | Name | Description |
|---|---|---|
| Select | sql | Query to set the search restriction on. |
| string | searchValue | The value of the search restriction. |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Remarks
Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.