Class PriceListProvider

List of pricelists from the PriceList table. Supported values in the AdditionalInfo:

  • alltrue|false. If true is specified, inactive items is also returned.
  • QuoteConnectionIdGets items for a specific Quote connection. If not specified, only SuperOffice pricelists (where IsErpCopy=false) will be returned.
AdditionalInfo string: "all=true&QuoteConnectionId=2"
Inheritance
object
AnyTableListProviderBase
PriceListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("PriceList")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("all", "Return all pricelists, not just the active ones", true)]
[MDOAdditionalInfo("quoteconnectionid", "Return only pricelists on the given connection", 123)]
public class PriceListProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

PriceListProvider()

List of pricelists from the PriceList table. Supported values in the AdditionalInfo:

  • alltrue|false. If true is specified, inactive items is also returned.
  • QuoteConnectionIdGets items for a specific Quote connection. If not specified, only SuperOffice pricelists (where IsErpCopy=false) will be returned.
AdditionalInfo string: "all=true&QuoteConnectionId=2"
Declaration
public PriceListProvider()

Fields

ProviderName

The name of the provider.

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

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

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

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