LoadConsumerRowsConfig

Configuration object for loading entity rows for a given consumer. The consumer has to exist in the current execution scope. The requested fields have to be loaded (=needed) in the consumer, otherwise the fields have no content.

Methods

addParameter

addParameter(pName, pValue): LoadConsumerRowsConfig

Adds a parameter value when loading the entity

Parameters

pName

string | number | boolean

name of parameter

pValue

string | number | boolean

value of parameter

Returns

LoadConsumerRowsConfig

---

applyRecordSorting

applyRecordSorting(pRecordSortingMode): LoadConsumerRowsConfig

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

LoadConsumerRowsConfig

---

consumer

consumer(pConsumer): LoadConsumerRowsConfig

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

Parameters

pConsumer

string | number | boolean

name of consumer

Returns

LoadConsumerRowsConfig

---

count

count(pCount): LoadConsumerRowsConfig

Sets the maximum number of rows to load.

Parameters

pCount

number

number of rows

Returns

LoadConsumerRowsConfig

---

entity

entity(pEntity): LoadConsumerRowsConfig

Sets the name of the entity to load

Parameters

pEntity

string | number | boolean

name of entity

Returns

LoadConsumerRowsConfig

---

fields

fields(pFields): LoadConsumerRowsConfig

Sets the name of the fields to load

Parameters

pFields

string[]

the name of fields

Returns

LoadConsumerRowsConfig

---

fieldValues

fieldValues(pNewFieldValues): LoadConsumerRowsConfig

Sets the field values for this entity

Parameters

pNewFieldValues

any

the new field values

Returns

LoadConsumerRowsConfig

---

filter

filter(pFilter): LoadConsumerRowsConfig

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

LoadConsumerRowsConfig

---

fromEntityRecordsRecipe

fromEntityRecordsRecipe(pEntityRecordsRecipe): LoadConsumerRowsConfig

This method is reserved for future use.

Parameters

pEntityRecordsRecipe

any

Returns

LoadConsumerRowsConfig

Throws

May throw an exception.

---

ignorePermissions

ignorePermissions(pIgnore): LoadConsumerRowsConfig

Ignores permissions, which are set for this entity

Parameters

pIgnore

boolean

true ignores permissions, default is false

Returns

LoadConsumerRowsConfig

---

locale

locale(pLocale): LoadConsumerRowsConfig

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

LoadConsumerRowsConfig

---

provider

provider(pProvider): LoadConsumerRowsConfig

Sets the name of the provider for loading the entity

Parameters

pProvider

string | number | boolean

name of provider

Returns

LoadConsumerRowsConfig

---

skipPrevalidation

skipPrevalidation(pSkip): LoadConsumerRowsConfig

Skips the pre-validation of changes in the entity

Parameters

pSkip

boolean

true skips the pre-validation false

Returns

LoadConsumerRowsConfig

---

startrow

startrow(pStartRow): LoadConsumerRowsConfig

Sets the starting row to load. Useful for paging

Parameters

pStartRow

number

the number of the row to start, 0 ist first

Returns

LoadConsumerRowsConfig

---

timezone

timezone(pTimezone): LoadConsumerRowsConfig

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

LoadConsumerRowsConfig

---

uid

uid(pUid): LoadConsumerRowsConfig

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

Parameters

pUid

string | number | boolean

value of uid

Returns

LoadConsumerRowsConfig

---

uids

uids(pUids): LoadConsumerRowsConfig

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

Parameters

pUids

string[]

values if uids

Returns

LoadConsumerRowsConfig

---

user

user(pUser): LoadConsumerRowsConfig

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

LoadConsumerRowsConfig