ReadRecordsResponse (Broadleaf Bulk Operations Common 1.7.2-GA API)

java.lang.Object
- com.broadleafcommerce.bulk.service.ReadRecordsResponse<P>

Type Parameters:

P - the type of the records that will be read
```
public final class ReadRecordsResponse<P>
extends Object
```
A response returned by BulkUpdateProcessor.readRecordsToProcess(BulkUpdate) indicating the results of attempting to read all of the records to process in an update.

Author:

Samarth Dhruva (samarthd)

See Also:

BulkUpdateProcessor.readRecordsToProcess(BulkUpdate)

Constructor Summary

Constructors
Constructor Description

ReadRecordsResponse(boolean successful, Stream<P> records, List<BulkUpdateError> errors)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`List<BulkUpdateError>`	`getErrors()`	If `successful` is false, then this should contain all of the errors encountered when attempting to read the records.
`Stream<P>`	`getRecords()`	If `successful` is true, then this should contain all of the records in the data store that should be processed in the update, as described by `BulkUpdateProcessor.readRecordsToProcess(BulkUpdate)`.
`int`	`hashCode()`
`boolean`	`isSuccessful()`	True if the records were read successfully, false otherwise.
`String`	`toString()`

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

- Constructor Detail
  - ReadRecordsResponse
```
public ReadRecordsResponse(boolean successful,
                           Stream<P> records,
                           List<BulkUpdateError> errors)
```
- Method Detail
  - isSuccessful
```
public boolean isSuccessful()
```
    True if the records were read successfully, false otherwise.
  - getRecords
```
public Stream<P> getRecords()
```
    If successful is true, then this should contain all of the records in the data store that should be processed in the update, as described by BulkUpdateProcessor.readRecordsToProcess(BulkUpdate).
  - getErrors
```
public List<BulkUpdateError> getErrors()
```
    If successful is false, then this should contain all of the errors encountered when attempting to read the records. These will be used by BulkUpdateManager and set on the corresponding BulkUpdate.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object