Show / Hide Table of Contents

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
Implements
ISoListProvider
ISoList
Inherited Members
AnyTableListProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)
AnyTableListProviderBase.GetHistoryItems()
AnyTableListProviderBase.GetRootItems()
AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.SetHistoryRestriction(Select)
AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)
AnyTableListProviderBase.ExecuteReader(SoCommand)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.ExcludeHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryInfo
AnyTableListProviderBase.HistoryItems
AnyTableListProviderBase.RootItems
AnyTableListProviderBase.HeadingItems
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.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, IPlugin

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

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
protected override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo
Overrides
AnyTableListProviderBase.TableInfo

Methods

GetMainQuery()

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
protected override Select GetMainQuery()
Returns
Type Description
Select
Overrides
AnyTableListProviderBase.GetMainQuery()

Init()

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

OnRead(SoDataReader, Int16)

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
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader
Int16 lastRank
Returns
Type Description
ISoListItem
Overrides
AnyTableListProviderBase.OnRead(SoDataReader, Int16)

SetSearchRestriction(Select, String)

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
protected override void SetSearchRestriction(Select sql, string searchValue)
Parameters
Type Name Description
Select sql
String searchValue
Overrides
AnyTableListProviderBase.SetSearchRestriction(Select, String)

Implements

ISoListProvider
ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top