Class PeriodProvider

Period values: Day, Week, Month, Quarter, Year

Inheritance
object
LiteralsOnlyBase
PeriodProvider
Inherited Members
Namespace: SuperOfficeCRMLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("Period")]
public class PeriodProvider : LiteralsOnlyBase, ISoListProvider, ISoList

Constructors

PeriodProvider()

Declaration
public PeriodProvider()

Fields

Day

Declaration
public const int Day = 1
Field Value
Type Description
int

HalfYear

Declaration
public const int HalfYear = 5
Field Value
Type Description
int

Month

Declaration
public const int Month = 3
Field Value
Type Description
int

ProviderNamePeriod

Declaration
public const string ProviderNamePeriod = "Period"
Field Value
Type Description
string

Quarter

Declaration
public const int Quarter = 4
Field Value
Type Description
int

Week

Declaration
public const int Week = 2
Field Value
Type Description
int

Year

Declaration
public const int Year = 6
Field Value
Type Description
int

Methods

AddItemsAsync(CancellationToken)

Subclass contract: use the RawRootItems and RawHeadingItems properties to add items to your literals-only list. The base class will then perform any search or flattening required.

Declaration
protected override Task AddItemsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
Remarks

Lists that only contain literals can be either flat or grouped. If you create a grouped list and the caller specifies a forceFlatList attribute, the base class will do the flattening for you.

Examples

This example shows a typical implementation of a literal list, in this case the date interval list from the Filter dialog:

[MDOProviderPlugin( "FilterFutureDate" )]
public class FilterFutureDateList : LiteralsOnlyBase
{
	protected override void AddItems()
	{
		RawRootItems.Add( new SoListItem( 1, "[SR_DATE_RANGE_3MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 2, "[SR_DATE_RANGE_4MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 3, "[SR_DATE_RANGE_6MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 4, "[SR_DATE_RANGE_1YEAR]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 5, "[SR_DATE_RANGE_2YEAR]", string.Empty, string.Empty ) );
	}
}

Note that using a search in this case yields unexpected results. The search is performed on the raw items, which contains resource tags - and that is not what you actually want to search against. So resources + search do not go together.

Implements

Extension Methods