LoadRowsConfig

Configuration object for loading entity rows independently.

Methods

addParameter

addParameter(pName, pValue): LoadRowsConfig

Adds a parameter value when loading the entity

Parameters

pName

string | number | boolean

name of parameter

pValue

string | number | boolean

value of parameter

Returns

LoadRowsConfig

---

applyRecordSorting

applyRecordSorting(pRecordSortingMode): LoadRowsConfig

Sets a flag that specifies whether the record order should be applied when loading the entity data.

If not set, this property is per default entities.RECORD_SORTING_NONE.

Loading and applying the record order costs resources and time but is necessary sometimes. This property will not affect required sorting columns, for example when the database requires a guaranteed order like the UID-column.

Parameters

pRecordSortingMode

string | number | boolean

when entities.RECORD_SORTING_FULL, the record order is calculated and applied when loading the rows. when entities.RECORD_SORTING_NONE, no record order is calculated and thus none is applied.

Returns

LoadRowsConfig

---

consumer

consumer(pConsumer): LoadRowsConfig

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

Parameters

pConsumer

string | number | boolean

name of consumer

Returns

LoadRowsConfig

---

count

count(pCount): LoadRowsConfig

Sets the maximum number of rows to load.

Parameters

pCount

number

number of rows

Returns

LoadRowsConfig

---

entity

entity(pEntity): LoadRowsConfig

Sets the name of the entity to load

Parameters

pEntity

string | number | boolean

name of entity

Returns

LoadRowsConfig

---

fields

fields(pFields): LoadRowsConfig

Sets the name of the fields to load

Parameters

pFields

string[]

the name of fields

Returns

LoadRowsConfig

---

fieldValues

fieldValues(pNewFieldValues): LoadRowsConfig

Sets the field values for this entity

Parameters

pNewFieldValues

any

the new field values

Returns

LoadRowsConfig

---

filter

filter(pFilter): LoadRowsConfig

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

LoadRowsConfig

---

fromEntityRecordsRecipe

fromEntityRecordsRecipe(pEntityRecordsRecipe): LoadRowsConfig

Configures row properties based on an entity records description in the form of an EntityRecordsRecipe. This method will overwrite any existing properties that are included in the EntityRecordsRecipe. The parameters will always be overwritten by the EntityRecordsRecipe, so call this method before using addParameter() if you want to preserve both parameter sets. Note that the "grouping" property is ignored since it does not affect the resulting data rows.

Parameters

pEntityRecordsRecipe

any

An entity records description in JSON format. Can be either an EntityRecordsRecipeBuilder object or its string representation.

Returns

LoadRowsConfig

Throws

May throw an exception.

---

ignorePermissions

ignorePermissions(pIgnore): LoadRowsConfig

Ignores permissions, which are set for this entity

Parameters

pIgnore

boolean

true ignores permissions, default is false

Returns

LoadRowsConfig

---

locale

locale(pLocale): LoadRowsConfig

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

LoadRowsConfig

---

provider

provider(pProvider): LoadRowsConfig

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

Parameters

pProvider

string | number | boolean

name of provider

Returns

LoadRowsConfig

---

skipPrevalidation

skipPrevalidation(pSkip): LoadRowsConfig

Skips the pre-validation of changes in the entity

Parameters

pSkip

boolean

true skips the pre-validation false

Returns

LoadRowsConfig

---

startrow

startrow(pStartRow): LoadRowsConfig

Sets the starting row to load. Useful for paging

Parameters

pStartRow

number

the number of the row to start, 0 ist first

Returns

LoadRowsConfig

---

timezone

timezone(pTimezone): LoadRowsConfig

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

LoadRowsConfig

---

uid

uid(pUid): LoadRowsConfig

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

Parameters

pUid

string | number | boolean

value of uid

Returns

LoadRowsConfig

---

uids

uids(pUids): LoadRowsConfig

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

Parameters

pUids

string[]

values if uids

Returns

LoadRowsConfig

---

user

user(pUser): LoadRowsConfig

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

LoadRowsConfig