Package com.broadleafcommerce.common.dataexport.service

Class ExportFileWriteResponse

java.lang.Object

com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse

public final class ExportFileWriteResponse
extends Object

Response returned by ExportFileWriter to indicate the results of writing to a file.

Author:

Samarth Dhruva (samarthd)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ExportFileWriteResponse	failure(String errorMessage)
String	getErrorMessage()	If successful is false, then this should contain a description of the error encountered when attempting to write to the file.
int	hashCode()
boolean	isSuccessful()	True if the write operation completed successfully, false otherwise.
static ExportFileWriteResponse	success()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

success

public static ExportFileWriteResponse success()

failure

public static ExportFileWriteResponse failure(String errorMessage)

isSuccessful

public boolean isSuccessful()

True if the write operation completed successfully, false otherwise.

getErrorMessage

public String getErrorMessage()

If successful is false, then this should contain a description of the error encountered when attempting to write to the file. 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