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 aSingleIndexRequest
for a particularIndexable
entity.SingleIndexRequestMessageFactory
injects allSingleIndexRequestMessageBuilders
and will use the first for whichcanBuild(Indexable)
is true.- Author:
- Samarth Dhruva (samarthd)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SingleIndexRequest<Identifiable>
build(Indexable entity)
Build aSingleIndexRequest
for the given entity.boolean
canBuild(Indexable entity)
Reports whether this builder can build aSingleIndexRequest
for the given entity.
-
-
-
Method Detail
-
canBuild
boolean canBuild(Indexable entity)
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
SingleIndexRequest<Identifiable> build(Indexable entity)
Build aSingleIndexRequest
for the given entity.- Parameters:
entity
- the entity to create aSingleIndexRequest
for.- Returns:
- a new
SingleIndexRequest
for the given entity
-
-