Class SuggestedAppointmentProvider

Suggested Appointment Provider creates a MDO list of suggested appointments for a given guide stage.

Inheritance
System.Object
AnyTableListProviderBase
SuggestedAppointmentProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("SuggestedAppointment")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("ShowDeleted", "Include deleted records", true)]
[MDOAdditionalInfo("SaleTypeStageLinkId", "Suggested appointments for a given stage link", 1234)]
[MDOAdditionalInfo("ProjectTypeStatusLinkId", "Suggested appointments for a given stage link", 4321)]
public class SuggestedAppointmentProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin

Constructors

SuggestedAppointmentProvider()

Declaration
public SuggestedAppointmentProvider()

Fields

ProviderName

The name of the provider.

Declaration
public const string ProviderName = "SuggestedAppointment"
Field Value
Type Description
System.String

Properties

TableInfo

The 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

Methods

GetMainQuery()

Get the query to retrieve roles in the database.

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

Init()

Initiate the provider after the method is called.

Declaration
protected override void Init()
Overrides

OnPreGetRootItems(List<ISoListItem>)

Event raised by after values are fetched from the database. Adding option for empty role at the beginning of list

Declaration
protected override void OnPreGetRootItems(List<ISoListItem> items)
Parameters
Type Name Description
System.Collections.Generic.List<ISoListItem> items

List of items returned from .
Overrides

OnRead(SoDataReader, Int16)

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.
System.Int16 lastRank

Value of the last rank populated.
Returns
Type Description
ISoListItem

Data read from the reader.
Overrides

SetSearchRestriction(Select, String)

If the input searchValue enables searching on the RoleTableInfo Name field.

Declaration
protected override void SetSearchRestriction(Select sql, string searchValue)
Parameters
Type Name Description
Select sql

The initial query
System.String searchValue

This search value specifies the starting string of the field
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)