Show / Hide Table of Contents

Class SatellitesProvider

SatelliteProvider creates a MDO list of satellites.

Inheritance
Object
AnyTableListProviderBase
SatellitesProvider
Implements
ISoListProvider
ISoList
Inherited Members
AnyTableListProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)
AnyTableListProviderBase.GetHistoryItems()
AnyTableListProviderBase.GetRootItems()
AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.SetHistoryRestriction(Select)
AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)
AnyTableListProviderBase.ExecuteReader(SoCommand)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryInfo
AnyTableListProviderBase.HistoryItems
AnyTableListProviderBase.RootItems
AnyTableListProviderBase.HeadingItems
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("Satellites")]
[MDOAdditionalInfo("addcentral", "add a the central satellite to list", "1")]
public class SatellitesProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin

Constructors

SatellitesProvider()

Declaration
public SatellitesProvider()

Fields

ProviderName

The name of the provider.

Declaration
public const string ProviderName = "Satellites"
Field Value
Type Description
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
AnyTableListProviderBase.TableInfo

Methods

GetMainQuery()

Get the query to retrieve satellites in the database.

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

Init()

Initiate the provider after the Construct(String, String, Int32[], Boolean, String, Boolean) method is called.

Declaration
protected override void Init()
Overrides
AnyTableListProviderBase.Init()

OnPreGetRootItems(List<ISoListItem>)

Event raised by GetRootItems() 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
List<ISoListItem> items

List of items returned from GetRootItems().

Overrides
AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)

OnRead(SoDataReader, Int16)

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 read from.

Int16 lastRank

Value of the last rank populated.

Returns
Type Description
ISoListItem

Data read from the reader.

Overrides
AnyTableListProviderBase.OnRead(SoDataReader, Int16)

SetSearchRestriction(Select, String)

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