de.hybris.platform.processing.distributed.simple.data

Class QueryBasedCreationData.Builder

java.lang.Object

de.hybris.platform.processing.distributed.simple.data.QueryBasedCreationData.Builder

Enclosing class:

QueryBasedCreationData

public static class QueryBasedCreationData.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QueryBasedCreationData	build()
QueryBasedCreationData.Builder	useDatabasePaging() Tells whether this ProcessCreationData implementation should use Database level paging or in-memory paging.
QueryBasedCreationData.Builder	withBatchSize(int batchSize) Allows to provide custom batch size.
QueryBasedCreationData.Builder	withBeforeQueryHook(QueryBasedCreationData.QueryHook beforeQueryHook) Allows to provide logic which will be executed before FlexibleSearchQuery is executed.
QueryBasedCreationData.Builder	withFlexibleSearchQuery(FlexibleSearchQuery flexibleSearchQuery) Allows to provide full FlexibleSearchQuery object.
QueryBasedCreationData.Builder	withHandlerId(java.lang.String handlerId) Allows to provide Spring Bean ID of a SimpleDistributedProcessHandler.
QueryBasedCreationData.Builder	withNodeGroup(java.lang.String nodeGroup) Allows to provide name of the NodeGroup which will execute process.
QueryBasedCreationData.Builder	withNumOfRetries(int numOfRetries) Allows to provide custom number of retries for Batch.
QueryBasedCreationData.Builder	withProcessId(java.lang.String processId) Allows to setup custom processId.
QueryBasedCreationData.Builder	withProcessModelClass(java.lang.Class<? extends SimpleDistributedProcessModel> processModelClass) Allows to provide custom process model class.
QueryBasedCreationData.Builder	withQuery(java.lang.String query) Allows to provide FlexibleSrarch query String.
QueryBasedCreationData.Builder	withQueryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams) Allows to provide query parameters when String based query is used.
QueryBasedCreationData.Builder	withResultClasses(java.util.List<java.lang.Class<?>> resultClasses) Allows to provide result classes when String based query is used.
QueryBasedCreationData.Builder	withScriptCode(java.lang.String scriptCode) Allows to provide Script code which will act as a SimpleBatchProcessor implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withHandlerId

public QueryBasedCreationData.Builder withHandlerId(java.lang.String handlerId)

Allows to provide Spring Bean ID of a SimpleDistributedProcessHandler.

withProcessId

public QueryBasedCreationData.Builder withProcessId(java.lang.String processId)

Allows to setup custom processId. Note that processId must be unique in the whole system.

withNodeGroup

public QueryBasedCreationData.Builder withNodeGroup(java.lang.String nodeGroup)

Allows to provide name of the NodeGroup which will execute process.

withBatchSize

public QueryBasedCreationData.Builder withBatchSize(int batchSize)

Allows to provide custom batch size. If not used default 100 will be chosen.

withNumOfRetries

public QueryBasedCreationData.Builder withNumOfRetries(int numOfRetries)

Allows to provide custom number of retries for Batch. If not used default 3 will be chosen.

withQuery

public QueryBasedCreationData.Builder withQuery(java.lang.String query)

Allows to provide FlexibleSrarch query String.

withQueryParams

public QueryBasedCreationData.Builder withQueryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams)

Allows to provide query parameters when String based query is used.

withResultClasses

public QueryBasedCreationData.Builder withResultClasses(java.util.List<java.lang.Class<?>> resultClasses)

Allows to provide result classes when String based query is used.

withScriptCode

public QueryBasedCreationData.Builder withScriptCode(java.lang.String scriptCode)

Allows to provide Script code which will act as a SimpleBatchProcessor implementation. When this option is chosen withHandlerId(String) has no effect.

withFlexibleSearchQuery

public QueryBasedCreationData.Builder withFlexibleSearchQuery(FlexibleSearchQuery flexibleSearchQuery)

Allows to provide full FlexibleSearchQuery object. When this option is chosen withQuery(String), withQueryParams(Map), withResultClasses(List) have no effect.

withBeforeQueryHook

public QueryBasedCreationData.Builder withBeforeQueryHook(QueryBasedCreationData.QueryHook beforeQueryHook)

Allows to provide logic which will be executed before FlexibleSearchQuery is executed. Usually useful to set session settings.

useDatabasePaging

public QueryBasedCreationData.Builder useDatabasePaging()

Tells whether this ProcessCreationData implementation should use Database level paging or in-memory paging. In-memory paging is the default. Please note that if you want to use Database level paging you must provide query with proper ORDER BY clause.

withProcessModelClass

public QueryBasedCreationData.Builder withProcessModelClass(java.lang.Class<? extends SimpleDistributedProcessModel> processModelClass)

Allows to provide custom process model class.

build

public QueryBasedCreationData build()