Class EntitySetTransactionsController

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<ITransaction>
BaseGridController<ITransaction>
BaseGridRelatedCollectionController<IEntitySetBase, ITransaction>
EntitySetTransactionsController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class EntitySetTransactionsController : BaseGridRelatedCollectionController<IEntitySetBase, ITransaction>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<ITransaction>, ICopyGridItemImplementor<ITransaction>, IGrid, IDeleteGridItemImplementor<ITransaction>, ISearchController, IModelViewController

Constructors

EntitySetTransactionsController(IBaseGridRelatedCollection<IEntitySetBase, ITransaction>)

Declaration
public EntitySetTransactionsController(IBaseGridRelatedCollection<IEntitySetBase, ITransaction> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IEntitySetBase, ITransaction> view

Properties

AllowCopyCommand

Indicates that by default selected entities can be copied by the user with the copy command

Declaration
public override bool AllowCopyCommand { get; }
Property Value
Type Description
bool
Overrides

AllowXMLImportExport

Indicates the command to allow the xml export of the data by the user is included in the InitCommands(IList<ViewCommand>)

The default is true if the type ITransaction derives from ISetCopier

Declaration
public override bool AllowXMLImportExport { get; }
Property Value
Type Description
bool
Overrides

AutoOpenNewItemInTab

Indicates when creating a new item in the grid that it should automatically be opened in a new tab as well

The default is true if the type ITransaction is an entity that is not a IsStandingDataEntity

Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type Description
bool
Overrides

CollectionRelationshipColumnName

This is the property on the ITransaction entities that holds a relationship value that points to the SingleItem type

This controller will automatically use that to filter the correct entities for the grid in AlterQuery(QueryableExecuter<TCollection>)

Declaration
public override string CollectionRelationshipColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.LegalEntity.IEntitySetBase, LemonEdge.API.Entities.FinancialServices.Transactions.ITransaction>.CollectionRelationshipColumnName

ContextHelpURL

An optional associated url of a help file for the view this controller works with

Declaration
public override string ContextHelpURL { get; }
Property Value
Type Description
string
Overrides

DefaultSearchColumn

The name of the column to use in the default search of text in the grid

Declaration
protected override string DefaultSearchColumn { get; }
Property Value
Type Description
string
Overrides

Methods

AlterQuery(QueryableExecuter<ITransaction>)

Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID

This is achieved via AddRelationshipJoin(QueryableExecuter<TCollection>) which can be overidden to customise how the entities of type ITransaction are precisely related to the SingleItem if not directly through that join

Declaration
protected override QueryableExecuter<ITransaction> AlterQuery(QueryableExecuter<ITransaction> query)
Parameters
Type Name Description
QueryableExecuter<ITransaction> query

The existing query to return all the results that will populate the grid
Returns
Type Description
QueryableExecuter<ITransaction>

An altered query that also ensures all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.LegalEntity.IEntitySetBase, LemonEdge.API.Entities.FinancialServices.Transactions.ITransaction>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Transactions.ITransaction>)

ColumnNames()

A list of all the columns to be dynamically created in the IBaseGrid<T>

This is used by the system to create the actual ControlDisplayInfo classes required from the Columns() property

You can override this to provide a simple definition of each column (combined with AlterControlInfo(ControlDisplayInfo) for more detail), or you can just override Columns() and ignore this
Declaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()
Returns
Type Description
IEnumerable<ControlDisplayInfoLight>

A list of all the columns to be dynamically created in the IBaseGrid<T>
Overrides

GetGridSourceItems()

Executes the query (GetCurrentQuery()) for the entities required in this grid, sets the total count (as it is different due to paging), and returns the results

Declaration
public override Task<IEnumerable<ITransaction>> GetGridSourceItems()
Returns
Type Description
Task<IEnumerable<ITransaction>>

The result of executing the GetCurrentQuery() to return all the entities that should be displayed in this grid
Overrides

InitCommands(IList<ViewCommand>)

Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands

Declaration
protected override void InitCommands(IList<ViewCommand> commands)
Parameters
Type Name Description
IList<ViewCommand> commands

The initial set of commands for this view
Overrides

OnTrackedItemChanged(object, string)

Provids a mechanism for handling changes for any item in the context

By default this is used to apply changes made to a selected item automatically to all other selected items in the grid (if multi-select is enabled)

Declaration
protected override void OnTrackedItemChanged(object item, string propName)
Parameters
Type Name Description
object item

The item that changed
string propName

The property name of the changed value
Overrides

UpdateNewItem(ITransaction)

Updates any new item created in this grid to also have the CollectionRelationshipColumnName property hold the value of the SingleItem ID

Declaration
protected override Task UpdateNewItem(ITransaction item)
Parameters
Type Name Description
ITransaction item

The new item created for this grid
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.LegalEntity.IEntitySetBase, LemonEdge.API.Entities.FinancialServices.Transactions.ITransaction>.UpdateNewItem(LemonEdge.API.Entities.FinancialServices.Transactions.ITransaction)

Implements

Extension Methods