Class ShipmentLinksListProvider

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Inheritance
object
AnyTableListProviderBase
ShipmentLinksListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("ShipmentLinks")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("local", "Local links", "false")]
[MDOAdditionalInfo("global", "Global links", "true")]
[MDOAdditionalInfo("shipmentId", "Shipment to search for links", "0")]
public class ShipmentLinksListProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

ShipmentLinksListProvider()

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
public ShipmentLinksListProvider()

Fields

ProviderName

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

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

_global

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected bool _global
Field Value
Type Description
bool

_hierarchy

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected bool _hierarchy
Field Value
Type Description
bool

_linkTableInfo

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected SLinkTableInfo _linkTableInfo
Field Value
Type Description
SLinkTableInfo

_local

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected bool _local
Field Value
Type Description
bool

_messageRow

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected SMessageRow _messageRow
Field Value
Type Description
SMessageRow

_relatedToShipment

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected int _relatedToShipment
Field Value
Type Description
int

_shipmentId

Create a list of specified mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected int _shipmentId
Field Value
Type Description
int

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

ExecuteReaderAsync(SoCommand, CancellationToken)

Perform the execute reader on the command fetching the first 500 items.
Override this methid if filters on the amount returned needs to be handled.

Declaration
protected override Task<SoDataReader> ExecuteReaderAsync(SoCommand cmd, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoCommand cmd

The command toe perform the execute reader on.
CancellationToken cancellationToken
Returns
Type Description
Task<SoDataReader>

The reader resulted from the execute reader method.
Overrides

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

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>)

Make the tree structure if necessary

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

OnRead(SoDataReader, short)

Raised every time a new row has been read from the database.
The implementation should read the 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