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.

Inheritance
object
AnyTableListProviderBase
TicketListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("Ticket")]
[MDOAdditionalInfo("nameformat", "Indicates how to format item name", "includePersonAndCompany")]
public class TicketListProvider : AnyTableListProviderBase, ISoListProvider, ISoList
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"

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"

GetMainQuery()

Get the main query for the list.

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select
Overrides
Remarks

Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.

GetRootItems()

Get all the root items from the database

Declaration
protected override List<ISoListItem> GetRootItems()
Returns
Type Description
List<ISoListItem>

History items.
Overrides
Remarks

Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.

Init()

Initiate the provider after the Construct(string, string, int[], bool, string, bool) method is called.

Declaration
protected override void Init()
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.

SetSearchRestriction(Select, string)

Set the search restriction on the list.

Declaration
protected override void SetSearchRestriction(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.
Overrides
Remarks

Sentry rights are honoured; if you do not have Read acces the ticket will not be listed here.

Implements

Extension Methods