Package com.broadleafcommerce.common.dataexport.service

Class RowGenerationResponse

java.lang.Object

com.broadleafcommerce.common.dataexport.service.RowGenerationResponse

public final class RowGenerationResponse
extends Object

A response returned by ExportProcessor.generateRows(List, Export) indicating the results of producing some rows in an export.

Author:

Samarth Dhruva (samarthd)

See Also:

• ExportProcessor.generateRows(List, Export)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static RowGenerationResponse	failure(String errorMessage)
String	getErrorMessage()	If successful is false, then this should contain a description of the error encountered when attempting to produce the rows.
List<Map<String,String>>	getRows()	If successful is true, then this should contain all of the generated rows.
int	hashCode()
boolean	isSuccessful()	True if the rows were produced successfully, false otherwise.
static RowGenerationResponse	success(List<Map<String,String>> rows)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

success

public static RowGenerationResponse success(List<Map<String,String>> rows)

failure

public static RowGenerationResponse failure(String errorMessage)

isSuccessful

public boolean isSuccessful()

True if the rows were produced successfully, false otherwise.

getRows

public List<Map<String,String>> getRows()

If successful is true, then this should contain all of the generated rows.

See Also:

• ExportProcessor.generateRows(List, Export)

getErrorMessage

public String getErrorMessage()

If successful is false, then this should contain a description of the error encountered when attempting to produce the rows. This will be used by ExportManager and set on the corresponding Export.

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