Package com.commercetools.api.models.payment

Interface PaymentResourceIdentifier

All Superinterfaces:

Identifiable<Payment>, ResourceIdentifier, WithKey

public interface PaymentResourceIdentifier
extends ResourceIdentifier, Identifiable<Payment>

ResourceIdentifier of a Payment. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

Example to create an instance using the builder pattern

     PaymentResourceIdentifier paymentResourceIdentifier = PaymentResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAYMENT	discriminator value for PaymentResourceIdentifier

Method Summary

Modifier and Type	Method	Description
static PaymentResourceIdentifierBuilder	builder()	builder factory method for PaymentResourceIdentifier
static PaymentResourceIdentifierBuilder	builder(PaymentResourceIdentifier template)	create builder for PaymentResourceIdentifier instance
static PaymentResourceIdentifier	deepCopy(PaymentResourceIdentifier template)	factory method to create a deep copy of PaymentResourceIdentifier
String	getId()	Unique identifier of the referenced Payment.
String	getKey()	User-defined unique identifier of the referenced Payment.
static PaymentResourceIdentifier	of()	factory method
static PaymentResourceIdentifier	of(PaymentResourceIdentifier template)	factory method to create a shallow copy PaymentResourceIdentifier
void	setId(String id)	Unique identifier of the referenced Payment.
void	setKey(String key)	User-defined unique identifier of the referenced Payment.
static com.fasterxml.jackson.core.type.TypeReference<PaymentResourceIdentifier>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentResourceIdentifier(Function<PaymentResourceIdentifier,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.ResourceIdentifier

getTypeId, withResourceIdentifier

Field Details

PAYMENT

static final String PAYMENT

discriminator value for PaymentResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

Unique identifier of the referenced Payment. Required if key is absent.

Specified by:

getId in interface Identifiable<Payment>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced Payment. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

Unique identifier of the referenced Payment. Required if key is absent.

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced Payment. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static PaymentResourceIdentifier of()

factory method

Returns:

instance of PaymentResourceIdentifier

of

static PaymentResourceIdentifier of(PaymentResourceIdentifier template)

factory method to create a shallow copy PaymentResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PaymentResourceIdentifier deepCopy(@Nullable
 PaymentResourceIdentifier template)

factory method to create a deep copy of PaymentResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentResourceIdentifierBuilder builder()

builder factory method for PaymentResourceIdentifier

Returns:

builder

builder

static PaymentResourceIdentifierBuilder builder(PaymentResourceIdentifier template)

create builder for PaymentResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentResourceIdentifier

default <T> T withPaymentResourceIdentifier(Function<PaymentResourceIdentifier,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<PaymentResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference