Skip to main content
Version: 2025.0

DeleteRowConfig

Methods

addParameter

addParameter(pName, pValue): DeleteRowConfig

Adds a parameter value when loading the entity

Parameters

pName
string | number | boolean

name of parameter

pValue
string | number | boolean

value of parameter

Returns

DeleteRowConfig

consumer

consumer(pConsumer): DeleteRowConfig

Sets the name of the consumer, which points to the entity to use

Parameters

pConsumer
string | number | boolean

name of consumer

Returns

DeleteRowConfig

count

count(pCount): DeleteRowConfig

Sets the maximum number of rows to load.

Parameters

pCount
number

number of rows

Returns

DeleteRowConfig

entity

entity(pEntity): DeleteRowConfig

Sets the name of the entity to load

Parameters

pEntity
string | number | boolean

name of entity

Returns

DeleteRowConfig

fields

fields(pFields): DeleteRowConfig

Sets the name of the fields to load

Parameters

pFields
string[]

the name of fields

Returns

DeleteRowConfig

fieldValues

fieldValues(pNewFieldValues): DeleteRowConfig

Sets the field values for this entity

Parameters

pNewFieldValues
any

the new field values

Returns

DeleteRowConfig

filter

filter(pFilter): DeleteRowConfig

Sets a filter when loading the entity Can contain the filter in json format as a string or a filter builder using neonFilter.createFilterGroup()

Parameters

pFilter
any

the filter, JSON - format as defined for entity-filters

Returns

DeleteRowConfig

fromEntityRecordsRecipe

fromEntityRecordsRecipe(pEntityRecordsRecipe): DeleteRowConfig

Sets all properties for a row config from an entity records description

The "grouping"-property is ignored because it will not affect the resulting data rows.

Parameters

pEntityRecordsRecipe
any

JSON entity records description; This may be a EntityRecordsRecipeBuilder or a String (stringified EntityRecordsRecipeBuilder)

Returns

DeleteRowConfig

Throws

May throw an exception.


ignorePermissions

ignorePermissions(pIgnore): DeleteRowConfig

Ignores permissions, which are set for this entity

Parameters

pIgnore
boolean

true ignores permissions, default is false

Returns

DeleteRowConfig

locale

locale(pLocale): DeleteRowConfig

Overwrites the locale to be used for execution. Only possible in a server process.

Parameters

pLocale
string | number | boolean

the locale to be used for execution

Returns

DeleteRowConfig

provider

provider(pProvider): DeleteRowConfig

Sets the name of the provider für loading the entity

Parameters

pProvider
string | number | boolean

name of provider

Returns

DeleteRowConfig

skipPrevalidation

skipPrevalidation(pSkip): DeleteRowConfig

Skips the pre-validation of changes in the entity

Parameters

pSkip
boolean

true skips the pre-validation false

Returns

DeleteRowConfig

startrow

startrow(pStartRow): DeleteRowConfig

Sets the starting row to load. Useful for paging

Parameters

pStartRow
number

the number of the row to start, 0 ist first

Returns

DeleteRowConfig

timezone

timezone(pTimezone): DeleteRowConfig

Overwrites the timezone to be used for execution. Only possible in a server process.

Parameters

pTimezone
string | number | boolean

the timezone to be used for execution

Returns

DeleteRowConfig

uid

uid(pUid): DeleteRowConfig

Set a single uid to load when loading the entity. Overrides uids().

Parameters

pUid
string | number | boolean

value of uid

Returns

DeleteRowConfig

uids

uids(pUids): DeleteRowConfig

Sets multiple uids to load when loading the entity. Overrides uid().

Parameters

pUids
string[]

values if uids

Returns

DeleteRowConfig

user

user(pUser): DeleteRowConfig

Overwrites the user to be used for execution. Only possible in a server process.

To perform an entities-action in a serverProcess with a user given here the process itself has to be run under an user-context. So this will only overwrite which user is used but it is not possible to run a serverProcess without an user-context and then set the user with this method. That is due to technical restrictions how and when the Package entities.*** is created within JDito.

In short: Set at least a technical user to execute the serverProcess when using this property in a serverProcess.

Parameters

pUser
string | number | boolean

the title for the user to be used for execution

Returns

DeleteRowConfig