Table of Contents

Class DefaultListSpec<T>

Namespace
The.Web.Entities
Assembly
Instagile.Web.Client.dll

A DefaultListSpec matched to entity type T.

public class DefaultListSpec<T> : DefaultListSpec, IListSpec where T : IEntity<T>

Type Parameters

T
Inheritance
DefaultListSpec<T>
Implements
Inherited Members

Methods

CreateLoadQuery(IEntityInfo, IEntityContext)

The query that supplies the list's rows: all of the entity type by default. Hosts filter it (search criteria, reminders), and the list machinery orders, pages and preloads it.

public override sealed IEntityQuery<IEntity> CreateLoadQuery(IEntityInfo _, IEntityContext context)

Parameters

_ IEntityInfo
context IEntityContext

Returns

IEntityQuery<IEntity>

CreateLoadQuery(IEntityContext)

Typed counterpart of CreateLoadQuery(IEntityInfo, IEntityContext).

public virtual IEntityQuery<T> CreateLoadQuery(IEntityContext context)

Parameters

context IEntityContext

Returns

IEntityQuery<T>

DefineColumns() 

public virtual IEnumerable<ColumnSpec> DefineColumns()

Returns

IEnumerable<ColumnSpec>

DefineColumns(IEntityInfo) 

public override sealed IEnumerable<ColumnSpec> DefineColumns(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

IEnumerable<ColumnSpec>

DefineOrdering()

The sort clauses to apply to the list. Return an empty sequence (the default) to use the entity's modelled default sort. Use By(PropertyInfo)/ByDescending(PropertyInfo) with T.Metadata properties to override it.

public virtual IEnumerable<ListOrdering> DefineOrdering()

Returns

IEnumerable<ListOrdering>

DefineOrdering(IEntityInfo)

The sort clauses to apply to the list. Return an empty sequence to use the entity's modelled default sort (SortProperty/SortAscending).

public override sealed IEnumerable<ListOrdering> DefineOrdering(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

IEnumerable<ListOrdering>

DefinePreloads()

Typed counterpart of DefinePreloads(IEntityInfo).

public virtual IEnumerable<RelationshipPath> DefinePreloads()

Returns

IEnumerable<RelationshipPath>

DefinePreloads(IEntityInfo)

The relationship paths the list's page query preloads, in addition to the paths its columns require: the list preload profile by default. Override to extend (with a base call) or replace.

public override sealed IEnumerable<RelationshipPath> DefinePreloads(IEntityInfo _)

Parameters

_ IEntityInfo

Returns

IEnumerable<RelationshipPath>

GetMessage(IEntityInfo, IEntity)

An optional status message for a row: table rows tint by its level and show its text as a tooltip; summary cards display it as a chip.

public override sealed Message? GetMessage(IEntityInfo _, IEntity row)

Parameters

_ IEntityInfo
row IEntity

Returns

Message?

GetMessage(T) 

public virtual Message? GetMessage(T row)

Parameters

row T

Returns

Message?

Match(IEntityInfo) 

public override bool Match(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

bool