Package com.broadleafcommerce.bulk.domain

Class BulkUpdateError

java.lang.Object

com.broadleafcommerce.bulk.domain.BulkUpdateError

All Implemented Interfaces:

Serializable

public class BulkUpdateError
extends Object
implements Serializable

A rich object detailing a reason why a BulkUpdate failed.

Author:

Samarth Dhruva (samarthd)

See Also:

BulkUpdate.errors, Serialized Form

Constructor Summary

Constructors

Constructor	Description
BulkUpdateError()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDescription()	A message describing the error encountered.
String	getRecordId()	If type is BulkUpdateErrorType.RECORD, this value should hold the ID of the record that experienced the error.
String	getRecordType()	If type is BulkUpdateErrorType.RECORD, this value should hold the domain/type of the record that experienced the error.
String	getStackTrace()	The string representation of the stacktrace.
String	getType()	The type of error that was encountered.
int	hashCode()
BulkUpdateError	setDescription(String description)	A message describing the error encountered.
BulkUpdateError	setRecordId(String recordId)	If type is BulkUpdateErrorType.RECORD, this value should hold the ID of the record that experienced the error.
BulkUpdateError	setRecordType(String recordType)	If type is BulkUpdateErrorType.RECORD, this value should hold the domain/type of the record that experienced the error.
BulkUpdateError	setStackTrace(String stackTrace)	The string representation of the stacktrace.
BulkUpdateError	setType(String type)	The type of error that was encountered.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkUpdateError

public BulkUpdateError()

Method Detail

getType

public String getType()

The type of error that was encountered.

Returns:

the type of error that was encountered

See Also:

BulkUpdateErrorType

getRecordType

public String getRecordType()

If type is BulkUpdateErrorType.RECORD, this value should hold the domain/type of the record that experienced the error.

Returns:

the domain/type of the specific record that encountered an error

getRecordId

public String getRecordId()

If type is BulkUpdateErrorType.RECORD, this value should hold the ID of the record that experienced the error.

Returns:

the ID of the specific record that encountered an error

getDescription

public String getDescription()

A message describing the error encountered.

Returns:

a message describing the error encountered

getStackTrace

public String getStackTrace()

The string representation of the stacktrace.

Returns:

the string representation of the stacktrace

setType

public BulkUpdateError setType(String type)

The type of error that was encountered.

Parameters:

type - the type of error that was encountered

Returns:

this.

See Also:

BulkUpdateErrorType

setRecordType

public BulkUpdateError setRecordType(String recordType)

If type is BulkUpdateErrorType.RECORD, this value should hold the domain/type of the record that experienced the error.

Parameters:

recordType - the domain/type of the specific record that encountered an error

Returns:

this.

setRecordId

public BulkUpdateError setRecordId(String recordId)

If type is BulkUpdateErrorType.RECORD, this value should hold the ID of the record that experienced the error.

Parameters:

recordId - the ID of the specific record that encountered an error

Returns:

this.

setDescription

public BulkUpdateError setDescription(String description)

A message describing the error encountered.

Parameters:

description - a message describing the error encountered

Returns:

this.

setStackTrace

public BulkUpdateError setStackTrace(String stackTrace)

The string representation of the stacktrace.

Parameters:

stackTrace - the string representation of the stacktrace

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object