Class PeriodEndAdjustmentsController

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

Constructors

PeriodEndAdjustmentsController(IBaseGridRelatedCollection<IPeriodEnd, IPeriodEndAdjustment>)

Declaration
public PeriodEndAdjustmentsController(IBaseGridRelatedCollection<IPeriodEnd, IPeriodEndAdjustment> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IPeriodEnd, IPeriodEndAdjustment> view

Properties

AllowOpenCommand

Indicates that by default selected entities can be opened by the user with the open command

Declaration
public override bool AllowOpenCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.AllowOpenCommand

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 IPeriodEndAdjustment is an entity that is not a IsStandingDataEntity

Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.AutoOpenNewItemInTab

CollectionRelationshipColumnName

This is the property on the IPeriodEndAdjustment 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.Accounting.IPeriodEnd, LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.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<IPeriodEndAdjustment>)

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 IPeriodEndAdjustment are precisely related to the SingleItem if not directly through that join

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

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

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.Accounting.IPeriodEnd, LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>)

CanDelete(IPeriodEndAdjustment)

Indicates if the selected item is allowed to be deleted based on the status of the item itself

The default implementation is false, allowing specific controller implementations to provide override values

Declaration
public override Task<bool> CanDelete(IPeriodEndAdjustment item)
Parameters
Type Name Description
IPeriodEndAdjustment item

The item to check if it can be deleted
Returns
Type Description
Task<bool>

True if the specified item can be deleted
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.CanDelete(LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment)

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
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.ColumnNames()

RemoveItems(IEnumerable<IPeriodEndAdjustment>)

Removes the specified set of items from the grid and if the items in the grid have a property marked as SequenceStart then it will decrement the ones above these deleted items to reflect their change in order

Declaration
public override Task RemoveItems(IEnumerable<IPeriodEndAdjustment> items)
Parameters
Type Name Description
IEnumerable<IPeriodEndAdjustment> items

The items to be removed from the CurrentItems
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides

UpdateNewItem(IPeriodEndAdjustment)

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(IPeriodEndAdjustment item)
Parameters
Type Name Description
IPeriodEndAdjustment 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.Accounting.IPeriodEnd, LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment>.UpdateNewItem(LemonEdge.API.Entities.FinancialServices.Accounting.IPeriodEndAdjustment)

Implements

Extension Methods