Skip to content

@serenity-is/corelib / IRowDefinition

Interface: IRowDefinition

Defined in: src/ui/datagrid/irowdefinition.ts:6

Metadata that describes a row type for grid and dialog integration. Implementations are resolved from the row type registry and used for permissions, identity and display name resolution.

Properties

concurrencyVersionProperty?

readonly optional concurrencyVersionProperty: string

Defined in: src/ui/datagrid/irowdefinition.ts:8

Name of the property that holds the optimistic concurrency version, if any.


deletePermission?

readonly optional deletePermission: string

Defined in: src/ui/datagrid/irowdefinition.ts:10

Permission required to delete rows.


idProperty?

readonly optional idProperty: string

Defined in: src/ui/datagrid/irowdefinition.ts:12

Name of the identity / primary key property.


insertPermission?

readonly optional insertPermission: string

Defined in: src/ui/datagrid/irowdefinition.ts:14

Permission required to insert rows.


isActiveProperty?

readonly optional isActiveProperty: string

Defined in: src/ui/datagrid/irowdefinition.ts:16

Name of the boolean property that marks a row as active.


isDeletedProperty?

readonly optional isDeletedProperty: string

Defined in: src/ui/datagrid/irowdefinition.ts:18

Name of the boolean property that marks a row as soft-deleted.


localTextPrefix?

readonly optional localTextPrefix: string

Defined in: src/ui/datagrid/irowdefinition.ts:20

Local text prefix for entity texts (display names, dialogs).


nameProperty?

readonly optional nameProperty: string

Defined in: src/ui/datagrid/irowdefinition.ts:22

Name of the property used as the display / name field.


readPermission?

readonly optional readPermission: string

Defined in: src/ui/datagrid/irowdefinition.ts:24

Permission required to read rows.


undeletePermission?

readonly optional undeletePermission: string

Defined in: src/ui/datagrid/irowdefinition.ts:26

Permission required to undelete rows.


updatePermission?

readonly optional updatePermission: string

Defined in: src/ui/datagrid/irowdefinition.ts:28

Permission required to update rows.