BatchIdHolder (Broadleaf Search Services Indexer Core Library 1.8.3-GA API)

java.lang.Object
- com.broadleafcommerce.search.index.core.queue.BatchIdHolder<ID>

Type Parameters:

ID -

All Implemented Interfaces:

IndexableTypeAware, Serializable
```
public class BatchIdHolder<ID extends Serializable>
extends Object
implements Serializable, IndexableTypeAware
```
Convenience class to hold a list of IDs for processing as a batch.

Author:

Kelly Tisdell (ktisdell)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

BatchIdHolder(@NonNull com.broadleafcommerce.search.api.type.IndexableType type, List<ID> ids)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ID>`	`getIds()`	The IDs contained in this batch.
`com.broadleafcommerce.search.api.type.IndexableType`	`getIndexableType()`	Components that implement this method should return the same, non-null value on each invocation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BatchIdHolder
```
public BatchIdHolder(@NonNull
                     @NonNull com.broadleafcommerce.search.api.type.IndexableType type,
                     List<ID> ids)
```
- Method Detail
  - getIndexableType
```
public final com.broadleafcommerce.search.api.type.IndexableType getIndexableType()
```
    Description copied from interface: IndexableTypeAware
    
    Components that implement this method should return the same, non-null value on each invocation. This should basically return a constant value.
    
    Specified by:
    
    getIndexableType in interface IndexableTypeAware
    
    Returns:
    
    the associated indexable type
  - getIds
```
public List<ID> getIds()
```
    The IDs contained in this batch.
    
    Returns:
    
    IDs contained in this batch