Interface SingleIndexRequestMessageBuilder
- All Superinterfaces:
com.broadleafcommerce.common.extension.data.DataRoutePartitionAware
public interface SingleIndexRequestMessageBuilder
extends com.broadleafcommerce.common.extension.data.DataRoutePartitionAware
A component that can build a
SingleIndexRequest
for a particular Indexable
entity. SingleIndexRequestMessageFactory
injects all
SingleIndexRequestMessageBuilders
and will use the first
for which canBuild(Indexable)
is true.- Author:
- Samarth Dhruva (samarthd)
-
Field Summary
Fields inherited from interface com.broadleafcommerce.common.extension.data.DataRoutePartitionAware
ALL_MATCH
-
Method Summary
Modifier and TypeMethodDescriptionBuild aSingleIndexRequest
for the given entity.boolean
Reports whether this builder can build aSingleIndexRequest
for the given entity.Methods inherited from interface com.broadleafcommerce.common.extension.data.DataRoutePartitionAware
getDataRoutePartition
-
Method Details
-
canBuild
Reports whether this builder can build aSingleIndexRequest
for the given entity.- Parameters:
entity
- the entity to check this builder's support for- Returns:
- true if the builder can build a
SingleIndexRequest
for the entity, false otherwise
-
build
Build aSingleIndexRequest
for the given entity.- Parameters:
entity
- the entity to create aSingleIndexRequest
for.- Returns:
- a new
SingleIndexRequest
for the given entity
-