Class AppointmentResource

Inheritance
object
AnyTableListProviderBase
AppointmentResource
Inherited Members
Namespace: SuperOfficeCRMLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("AppointmentResource")]
[MDOAdditionalInfo("remove_conflicts", "Removes resources with conflicts. Requires start and end times for conflict, either explicitly set or from appointment_id.", false)]
[MDOAdditionalInfo("conflict_start", "Conflict datetime start.")]
[MDOAdditionalInfo("conflict_end", "Conflict datetime end.")]
[MDOAdditionalInfo("conflict_utc", "Conflict datetimes are in UTC time.")]
[MDOAdditionalInfo("appointment_id", "Appointment id used for conflict resolution. Preferentially used to determine conflict start/end.")]
public class AppointmentResource : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

AppointmentResource()

Declaration
public AppointmentResource()

Fields

AppointmentId

Appointment id used for conflict resolution. Preferentially used to determine conflict start/end.

Declaration
public const string AppointmentId = "appointment_id"
Field Value
Type Description
string

ConflictEndDateTime

Conflict datetime end.

Declaration
public const string ConflictEndDateTime = "conflict_end"
Field Value
Type Description
string

ConflictIsUtc

Conflict is UTC

Declaration
public const string ConflictIsUtc = "conflict_utc"
Field Value
Type Description
string

ConflictStartDateTime

Conflict datetime start.

Declaration
public const string ConflictStartDateTime = "conflict_start"
Field Value
Type Description
string

ProviderName

Declaration
public const string ProviderName = "AppointmentResource"
Field Value
Type Description
string

RemoveConflicts

Removes resources with conflicts. Requires start and end times for conflict, either explicitly set or from appointment_id.

Declaration
public const string RemoveConflicts = "remove_conflicts"
Field Value
Type Description
string

Properties

HistoryInfo

History information for the supported list

Declaration
public override HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Overrides

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

Methods

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
TaskSelect
Overrides

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

OnPostGetRootItemsAsync(List<ISoListItem>)

Event raised by GetRootItemsAsync(CancellationToken) after values are fetched from the database.

Declaration
protected override Task OnPostGetRootItemsAsync(List<ISoListItem> items)
Parameters
Type Name Description
ListISoListItem items

List of items returned from GetRootItemsAsync(CancellationToken).
Returns
Type Description
Task
Overrides

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

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

Implements

Extension Methods