Web SDK documentation
  1. Classes
  2. DynamicBulkIIdentifiedResolver

File

core/dynamic-component/abstract-id-resolver.ts

Extends

DynamicBulkDetailsResolver

Index

Properties
Methods

Constructor

constructor(dynamicResolver: DynamicResolverService, service?)
Parameters :
Name Type Optional
dynamicResolver DynamicResolverService No
service Yes

Properties

Protected Abstract Readonly typeForErrorMessage
Type : string

Used within the buildRetrievalAlert method to generate the alert text. For ManagedObjects this would be set to managedObject, for events e.g. to event.
Protected idsGroupedByBulkId
Default value : new Map<number, string[]>()

Map containing the ids to be retrieved per bulk request.
resultsOfBulkLoad
Type : Observable<literal type>

Provides an Observable of the results of all bulk requests.

Methods

buildRetrievalAlert
buildRetrievalAlert(entity: Partial, errors: DynamicBulkRetrievalError[])
Parameters :
Name Type Optional
entity Partial<T> No
errors DynamicBulkRetrievalError[] No
Returns : DynamicComponentAlert
Protected extractIdsToBeRetrieved
extractIdsToBeRetrieved(valueBehindAttribute: Partial | Array>)
Parameters :
Name Type Optional
valueBehindAttribute Partial<T> | Array<Partial<T>> No
Returns : string | []
Protected performBulkRequest
performBulkRequest(uniqIds: string[], bulkRequestId: number)
Parameters :
Name Type Optional
uniqIds string[] No
bulkRequestId number No
Returns : Promise | Observable
Protected serializeSingleObject
serializeSingleObject(obj: T)
Parameters :
Name Type Optional
obj T No
Returns : Partial<T>
addIdsToBeLoaded
addIdsToBeLoaded(bulkRequestId: number, ...ids: string[])

Adds a single id or an array of ids to the idsGroupedByBulkId Map for the provided bulkRequestId.

Parameters :
Name Type Optional
bulkRequestId number No
ids string[] No
Returns : void
getResult$
getResult$(bulkRequestId: number)

Provides an Observable of the results of the given bulkRequestId.

Parameters :
Name Type Optional
bulkRequestId number No
Returns : Observable<literal type>
Protected isEntityOfId
isEntityOfId(obj: T, id: string)

Checks wether an object is of given id. Will by default compare the id attribute with the given id.

Parameters :
Name Type Optional
obj T No
id string No
Returns : boolean
resolve
resolve(config: any, attribute: string, bulkRequestId: number)
Parameters :
Name Type Optional
config any No
attribute string No
bulkRequestId number No
Returns : T | Array | DynamicComponentAlert | Promise | Observable
serialize
serialize(config: any, attribute: string)

Default implementation compatible with serializing an object or an Array of objects. Calls serializeSingleObject for an object and for every entry within the array.

Parameters :
Name Type Optional
config any No
attribute string No
Returns : Partial | Array

results matching ""

    No results matching ""