Package com.commercetools.api.models.error

Interface ExpiredCustomerEmailTokenError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ExpiredCustomerEmailTokenErrorImpl

public interface ExpiredCustomerEmailTokenError
extends ErrorObject

Returned when the provided email token of the Customer has expired.

The error is returned as a failed response to:

• Get Customer by email token and Get Customer in Store by email token requests
• Verify email of Customer and Verify email of Customer in Store requests

Example to create an instance using the builder pattern

     ExpiredCustomerEmailTokenError expiredCustomerEmailTokenError = ExpiredCustomerEmailTokenError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPIRED_CUSTOMER_EMAIL_TOKEN	discriminator value for ExpiredCustomerEmailTokenError

Method Summary

Modifier and Type	Method	Description
static ExpiredCustomerEmailTokenErrorBuilder	builder()	builder factory method for ExpiredCustomerEmailTokenError
static ExpiredCustomerEmailTokenErrorBuilder	builder(ExpiredCustomerEmailTokenError template)	create builder for ExpiredCustomerEmailTokenError instance
ExpiredCustomerEmailTokenError	copyDeep()
static ExpiredCustomerEmailTokenError	deepCopy(ExpiredCustomerEmailTokenError template)	factory method to create a deep copy of ExpiredCustomerEmailTokenError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"The given email token has expired."
static ExpiredCustomerEmailTokenError	of()	factory method
static ExpiredCustomerEmailTokenError	of(ExpiredCustomerEmailTokenError template)	factory method to create a shallow copy ExpiredCustomerEmailTokenError
void	setMessage(String message)	"The given email token has expired."
static com.fasterxml.jackson.core.type.TypeReference<ExpiredCustomerEmailTokenError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withExpiredCustomerEmailTokenError(Function<ExpiredCustomerEmailTokenError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

EXPIRED_CUSTOMER_EMAIL_TOKEN

static final String EXPIRED_CUSTOMER_EMAIL_TOKEN

discriminator value for ExpiredCustomerEmailTokenError

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()

"The given email token has expired."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"The given email token has expired."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static ExpiredCustomerEmailTokenError of()

factory method

Returns:

instance of ExpiredCustomerEmailTokenError

of

static ExpiredCustomerEmailTokenError of(ExpiredCustomerEmailTokenError template)

factory method to create a shallow copy ExpiredCustomerEmailTokenError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ExpiredCustomerEmailTokenError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static ExpiredCustomerEmailTokenError deepCopy(@Nullable
 ExpiredCustomerEmailTokenError template)

factory method to create a deep copy of ExpiredCustomerEmailTokenError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ExpiredCustomerEmailTokenErrorBuilder builder()

builder factory method for ExpiredCustomerEmailTokenError

Returns:

builder

builder

static ExpiredCustomerEmailTokenErrorBuilder builder(ExpiredCustomerEmailTokenError template)

create builder for ExpiredCustomerEmailTokenError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withExpiredCustomerEmailTokenError

default <T> T withExpiredCustomerEmailTokenError(Function<ExpiredCustomerEmailTokenError,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<ExpiredCustomerEmailTokenError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference