Skip to main content
Version: 2026.0

entities

Methods​

createConfigForAddingRows​

createConfigForAddingRows(): CreateRowConfig

Create and return a config object for updating rows.

Returns​

CreateRowConfig

RestConfig

createConfigForDeletingRows​

createConfigForDeletingRows(): DeleteRowConfig

Create and return a config object for deleting rows.

Returns​

DeleteRowConfig

RestConfig

createConfigForLoadingConsumerRows​

createConfigForLoadingConsumerRows(): LoadConsumerRowsConfig

Create and return a config object for loading rows.

Returns​

LoadConsumerRowsConfig

RestConfig

createConfigForLoadingRows​

createConfigForLoadingRows(): LoadRowsConfig

Create and return a config object for loading rows.

Returns​

LoadRowsConfig

RestConfig

createConfigForUpdatingRows​

createConfigForUpdatingRows(): UpdateRowConfig

Create and return a config object for updating rows.

Returns​

UpdateRowConfig

RestConfig

createRow​

createRow(pCreateConfig): string

Adds a row of a specific entity with all the given field values

mandatory for config: entity, fieldValues optional for config: provider, parameters, ignorePermissions, user (only in server process)

Parameters​

pCreateConfig
CreateRowConfig

Returns​

string

Throws​

Exception

deleteRow​

deleteRow(pDeleteConfig): void

Deletes a single row with the passed uid

mandatory for config: entity, uid optional for config: provider, parameters, ignorePermissions, user (only in server process)

Parameters​

pDeleteConfig
DeleteRowConfig

Returns​

void

Throws​

AditoException

getRow​

getRow(pLoadConfig): any

Loads a single row. The notation of this result is json.

mandatory for config: entity, fields, uid optional for config: provider, parameters, user (only in server process)

Parameters​

pLoadConfig
LoadRowsConfig

Returns​

any

Throws​

May throw an exception.

getRowCount​

getRowCount(pLoadConfig): number

Loads the number of rows. If the uids-property in the given config is set to an empty array this method will return the value 0 without consulting the entity. However, this will not happen when null is passed in the uids-property.

mandatory for config (independent entity): entity optional for config (independent entity): provider, parameters, uids/filter, user (only in server process)

mandatory for config (consumer entity): consumer optional for config (consumer entity): filter

Parameters​

pLoadConfig
CommonLoadRowsConfig

Returns​

number

Throws​

May throw an exception.

getRows​

getRows(pLoadConfig): any[]

Loads multiple row. The notation of this result is an array of json.

If the uids-property in the given config is set to an empty array this method will return immediately an empty array without consulting the entity. However, this will not happen when null is passed in the uids-property.

mandatory for config (independent entity): entity, fields optional for config (independent entity): optional: provider, parameters, uids, filter, startrow, count Passing in the fields-property only the "#UID"-field will use a performance optimized loading mechanism if the RecordContainer supports this. Every DBRecordContainer supports this out of the box.

mandatory for config (consumer entity): mandatory: consumer, fields optional for config (consumer entity): optional: filter, startrow, count

Parameters​

pLoadConfig
CommonLoadRowsConfig

Returns​

any[]

Throws​

May throw an exception.

invalidateCache​

invalidateCache(pEntity?, pRecordContainer?): boolean

Will delete all cache entries for each session on the given record container on the given entity.

Parameters​

pEntity?
string | number | boolean

The entity for which the cache entries shall be deleted.

pRecordContainer?
string | number | boolean

The record container for which the cache entries shall be deleted.

Returns​

boolean

If any cache entries have been deleted.

Throws​

May throw an exception.

updateRow​

updateRow(pUpdateConfig): void

Loads the entity with the passed uid and saves new field values on it

mandatory for config: entity, fieldValues, uid optional for config: provider, parameters, ignorePermissions, user (only in server process)

Parameters​

pUpdateConfig
UpdateRowConfig

Returns​

void

Throws​

AditoException

Properties​

EOF​

number

Constant for the number of rows:

Get all rows.

RECORD_SORTING_FULL​

string

Constant for specifying a sorting mode when loading data. FULL means use the full bandwidth of available order configurations.

For more details, see:

  • applyRecordSorting of createConfigForLoadingRows

  • applyRecordSorting of createConfigForConsumerLoadingRows

RECORD_SORTING_NONE​

string

Constant for specifying a sorting mode when loading data. NONE means no particular sorting.

For more details, see:

  • applyRecordSorting of createConfigForLoadingRows

  • applyRecordSorting of createConfigForConsumerLoadingRows