Class SaleGuideStage
MDO provider for the stage list, customized for the sale guide stage button row
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("SaleGuideStage")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("sale_id", "Sale to get stages for", "1234")]
[MDOAdditionalInfo("saletype_id", "Sale Type to get stages for", "234")]
[MDOAdditionalInfo("prob_id", "Sale Stage id", "234")]
public class SaleGuideStage : AnyTableListProviderBase, ISoListProvider, ISoList
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
Constructors
SaleGuideStage()
MDO provider for the stage list, customized for the sale guide stage button row
Declaration
public SaleGuideStage()
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
Fields
ProviderName
MDO provider for the stage list, customized for the sale guide stage button row
Declaration
public const string ProviderName = "SaleGuideStage"
Field Value
Type | Description |
---|---|
string |
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
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
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
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
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
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
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
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
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.
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
Remarks
AdditionalInfo is a name/value string, and can be either sale_id=<id> or saletype_id=<id>. If sale_id is given,
then you get back all the stages valid for this sale, with stylehint currentStage for the current one; if saletype_id is given,
you get back all stages valid for this sale type, but (obviously) with no current indication.
If no additionalInfo is given, all stages are returned. The 'special' stages Open, Lost and Sold are not included in this
provider; use the SaleStage provider for those.