Package com.commercetools.api.models.error

Interface ReferenceExistsError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ReferenceExistsErrorImpl

public interface ReferenceExistsError
extends ErrorObject

Returned when a resource cannot be deleted because it is being referenced by another resource.

Example to create an instance using the builder pattern

     ReferenceExistsError referenceExistsError = ReferenceExistsError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REFERENCE_EXISTS	discriminator value for ReferenceExistsError

Method Summary

Modifier and Type	Method	Description
static ReferenceExistsErrorBuilder	builder()	builder factory method for ReferenceExistsError
static ReferenceExistsErrorBuilder	builder(ReferenceExistsError template)	create builder for ReferenceExistsError instance
static ReferenceExistsError	deepCopy(ReferenceExistsError template)	factory method to create a deep copy of ReferenceExistsError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"Can not delete a $resource while it is referenced by at least one $referencedBy."
ReferenceTypeId	getReferencedBy()	Type of referenced resource.
static ReferenceExistsError	of()	factory method
static ReferenceExistsError	of(ReferenceExistsError template)	factory method to create a shallow copy ReferenceExistsError
void	setMessage(String message)	"Can not delete a $resource while it is referenced by at least one $referencedBy."
void	setReferencedBy(ReferenceTypeId referencedBy)	Type of referenced resource.
static com.fasterxml.jackson.core.type.TypeReference<ReferenceExistsError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withReferenceExistsError(Function<ReferenceExistsError,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

setValue, values, withErrorObject

Field Details

REFERENCE_EXISTS

static final String REFERENCE_EXISTS

discriminator value for ReferenceExistsError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Returns:

code

getMessage

@NotNull
@NotNull String getMessage()

"Can not delete a $resource while it is referenced by at least one $referencedBy."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getReferencedBy

ReferenceTypeId getReferencedBy()

Type of referenced resource.

Returns:

referencedBy

setMessage

void setMessage(String message)

"Can not delete a $resource while it is referenced by at least one $referencedBy."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setReferencedBy

void setReferencedBy(ReferenceTypeId referencedBy)

Type of referenced resource.

Parameters:

referencedBy - value to be set

of

static ReferenceExistsError of()

factory method

Returns:

instance of ReferenceExistsError

of

static ReferenceExistsError of(ReferenceExistsError template)

factory method to create a shallow copy ReferenceExistsError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ReferenceExistsError deepCopy(@Nullable
 ReferenceExistsError template)

factory method to create a deep copy of ReferenceExistsError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ReferenceExistsErrorBuilder builder()

builder factory method for ReferenceExistsError

Returns:

builder

builder

static ReferenceExistsErrorBuilder builder(ReferenceExistsError template)

create builder for ReferenceExistsError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withReferenceExistsError

default <T> T withReferenceExistsError(Function<ReferenceExistsError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ReferenceExistsError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference