IBatchJobStrategy

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

manager_EntityManagerRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Protected get**activeManager_**(): EntityManager

Returns

EntityManager

EntityManagerEntityManagerRequired

Methods

atomicPhase_

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

TResultobjectRequired

TErrorobjectRequired

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required

the transactional work to be done

isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>

the isolation level to be used for the work.

maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>

Potential error handler

Returns

Promise<TResult>

PromisePromise<TResult>Required

the result of the transactional work

---

buildTemplate

**buildTemplate**(): Promise<string>

Builds and returns a template file that can be downloaded and filled in

Returns

Promise<string>

PromisePromise<string>Required

---

preProcessBatchJob

**preProcessBatchJob**(batchJobId): Promise<void>

Method for pre-processing a batch job

Parameters

batchJobIdstringRequired

Returns

Promise<void>

PromisePromise<void>Required

---

prepareBatchJobForProcessing

**prepareBatchJobForProcessing**(batchJobEntity, req): Promise<[CreateBatchJobInput](/references/services/types/CreateBatchJobInput)>

Method for preparing a batch job for processing

Parameters

batchJobEntityCreateBatchJobInputRequired

reqRequestRequired

Returns

Promise<CreateBatchJobInput>

PromisePromise<CreateBatchJobInput>Required

---

processJob

**processJob**(batchJobId): Promise<void>

Method does the actual processing of the job. Should report back on the progress of the operation.

Parameters

batchJobIdstringRequired

Returns

Promise<void>

PromisePromise<void>Required

---

shouldRetryTransaction_

Protected **shouldRetryTransaction_**(err): boolean

Parameters

errRecord<string, unknown> | { code: string }Required

Returns

boolean

booleanboolean

---

withTransaction

**withTransaction**(transactionManager?): [IBatchJobStrategy](/references/services/interfaces/IBatchJobStrategy)

Parameters

transactionManagerEntityManager

Returns

IBatchJobStrategy

IBatchJobStrategyIBatchJobStrategyRequired