Package com.commercetools.api.models.error

Interface ExpiredCustomerPasswordTokenError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ExpiredCustomerPasswordTokenErrorImpl

public interface ExpiredCustomerPasswordTokenError
extends ErrorObject

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

The error is returned as a failed response to:

• Get Customer by password token and Get Customer in Store by password token requests
• Reset password of Customer and Reset password of Customer in Store requests

Example to create an instance using the builder pattern

     ExpiredCustomerPasswordTokenError expiredCustomerPasswordTokenError = ExpiredCustomerPasswordTokenError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPIRED_CUSTOMER_PASSWORD_TOKEN	discriminator value for ExpiredCustomerPasswordTokenError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

EXPIRED_CUSTOMER_PASSWORD_TOKEN

static final String EXPIRED_CUSTOMER_PASSWORD_TOKEN

discriminator value for ExpiredCustomerPasswordTokenError

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 password token has expired."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"The given password token has expired."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static ExpiredCustomerPasswordTokenError of()

factory method

Returns:

instance of ExpiredCustomerPasswordTokenError

of

static ExpiredCustomerPasswordTokenError of(ExpiredCustomerPasswordTokenError template)

factory method to create a shallow copy ExpiredCustomerPasswordTokenError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ExpiredCustomerPasswordTokenError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static ExpiredCustomerPasswordTokenError deepCopy(@Nullable
 ExpiredCustomerPasswordTokenError template)

factory method to create a deep copy of ExpiredCustomerPasswordTokenError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ExpiredCustomerPasswordTokenErrorBuilder builder()

builder factory method for ExpiredCustomerPasswordTokenError

Returns:

builder

builder

static ExpiredCustomerPasswordTokenErrorBuilder builder(ExpiredCustomerPasswordTokenError template)

create builder for ExpiredCustomerPasswordTokenError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withExpiredCustomerPasswordTokenError

default <T> T withExpiredCustomerPasswordTokenError(Function<ExpiredCustomerPasswordTokenError,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<ExpiredCustomerPasswordTokenError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference