com.adobe.fd.ccm.multichannel.batch.api.builder

Interface BatchConfigBuilder

public interface BatchConfigBuilder

Builder to construct the immutable @BatchConfig instance

Method Summary

Modifier and Type	Method and Description
BatchConfig	build() Build the immutable Batch Config instance
BatchConfigBuilder	setBatchType(BatchType batchType) Set the batch type to be used for rendering
BatchConfigBuilder	setLocale(String locale) Set the locale to be used while rendering the document
BatchConfigBuilder	setPostProcessor(PostProcessor postProcessor) Configure the post-processor to be executed after executing batch logic.
BatchConfigBuilder	setPreProcessor(PreProcessor preProcessor) Configure the pre-processor to be executed before actual executing batch logic.
BatchConfigBuilder	setRecordPath(String recordID) Set the record Id ie json pointer to the data, to uniquely identify in Result after batch execution.The provided json-pointer will be resolved from input data.
BatchConfigBuilder	setUsePrefillService(boolean usePrefillService) Configuration to either use input data as argument and use prefill service defined on IC or ignore prefill service provided in IC and use complete input as actual data.

Method Detail

setPreProcessor

BatchConfigBuilder setPreProcessor(PreProcessor preProcessor)

Configure the pre-processor to be executed before actual executing batch logic.

Parameters:

preProcessor - pre-processor implementation of @PreProcessor

Returns:

Batch Config Builder

setPostProcessor

BatchConfigBuilder setPostProcessor(PostProcessor postProcessor)

Configure the post-processor to be executed after executing batch logic.

Parameters:

postProcessor - post-processor implementation of @{@link PostProcessor

Returns:

Batch Config Builder

setBatchType

BatchConfigBuilder setBatchType(BatchType batchType)

Set the batch type to be used for rendering

Parameters:

batchType - type of rendering @BatchType

Returns:

Batch Config Builder

setLocale

BatchConfigBuilder setLocale(String locale)

Set the locale to be used while rendering the document

Parameters:

locale - locale to be used while rendering the document

Returns:

Batch Config Builder

setRecordPath

BatchConfigBuilder setRecordPath(String recordID)

Set the record Id ie json pointer to the data, to uniquely identify in Result after batch execution.The provided json-pointer will be resolved from input data. eg /account/id

Parameters:

recordID - json pointer to the data

Returns:

Batch Config Builder

setUsePrefillService

BatchConfigBuilder setUsePrefillService(boolean usePrefillService)

Configuration to either use input data as argument and use prefill service defined on IC or ignore prefill service provided in IC and use complete input as actual data. If false then use use input as actual data adn ignore prefill service, true then use prefill service defined on IC and use input as arguments.

Parameters:

usePrefillService -

Returns:

Batch Config Builder

build

BatchConfig build()
           throws BatchException

Build the immutable Batch Config instance

Returns:

the Batch Config instance

Throws:

BatchException