Package com.commercetools.importapi.models.common

Interface KeyReference

All Known Subinterfaces:

CartDiscountKeyReference, CartKeyReference, CategoryKeyReference, ChannelKeyReference, CustomerGroupKeyReference, CustomerKeyReference, CustomObjectKeyReference, DiscountCodeKeyReference, OrderKeyReference, PaymentKeyReference, PriceKeyReference, ProductDiscountKeyReference, ProductKeyReference, ProductTypeKeyReference, ProductVariantKeyReference, ShippingMethodKeyReference, StateKeyReference, StoreKeyReference, TaxCategoryKeyReference, TypeKeyReference

public interface KeyReference

References a resource by key.

Example to create a subtype instance using the builder pattern

     KeyReference keyReference = KeyReference.cartDiscountBuilder()
             key("{key}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CartKeyReferenceBuilder	cartBuilder()	builder for cart subtype
static CartDiscountKeyReferenceBuilder	cartDiscountBuilder()	builder for cartDiscount subtype
static CategoryKeyReferenceBuilder	categoryBuilder()	builder for category subtype
static ChannelKeyReferenceBuilder	channelBuilder()	builder for channel subtype
static CustomerKeyReferenceBuilder	customerBuilder()	builder for customer subtype
static CustomerGroupKeyReferenceBuilder	customerGroupBuilder()	builder for customerGroup subtype
static KeyReference	deepCopy(KeyReference template)	factory method to create a deep copy of KeyReference
static DiscountCodeKeyReferenceBuilder	discountCodeBuilder()	builder for discountCode subtype
@NotNull String	getKey()
@NotNull ReferenceType	getTypeId()	The type of the referenced resource.
static CustomObjectKeyReferenceBuilder	keyValueDocumentBuilder()	builder for keyValueDocument subtype
static OrderKeyReferenceBuilder	orderBuilder()	builder for order subtype
static PaymentKeyReferenceBuilder	paymentBuilder()	builder for payment subtype
static PriceKeyReferenceBuilder	priceBuilder()	builder for price subtype
static ProductKeyReferenceBuilder	productBuilder()	builder for product subtype
static ProductDiscountKeyReferenceBuilder	productDiscountBuilder()	builder for productDiscount subtype
static ProductTypeKeyReferenceBuilder	productTypeBuilder()	builder for productType subtype
static ProductVariantKeyReferenceBuilder	productVariantBuilder()	builder for productVariant subtype
void	setKey(String key)	set key
static ShippingMethodKeyReferenceBuilder	shippingMethodBuilder()	builder for shippingMethod subtype
static StateKeyReferenceBuilder	stateBuilder()	builder for state subtype
static StoreKeyReferenceBuilder	storeBuilder()	builder for store subtype
static TaxCategoryKeyReferenceBuilder	taxCategoryBuilder()	builder for taxCategory subtype
static TypeKeyReferenceBuilder	typeBuilder()	builder for type subtype
static com.fasterxml.jackson.core.type.TypeReference<KeyReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withKeyReference(Function<KeyReference,T> helper)	accessor map function

Method Details

getKey

@NotNull
@NotNull String getKey()

Returns:

key

getTypeId

@NotNull
@NotNull ReferenceType getTypeId()

The type of the referenced resource.

Returns:

typeId

setKey

void setKey(String key)

set key

Parameters:

key - value to be set

deepCopy

@Nullable
static KeyReference deepCopy(@Nullable
 KeyReference template)

factory method to create a deep copy of KeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

cartDiscountBuilder

static CartDiscountKeyReferenceBuilder cartDiscountBuilder()

builder for cartDiscount subtype

Returns:

builder

cartBuilder

static CartKeyReferenceBuilder cartBuilder()

builder for cart subtype

Returns:

builder

categoryBuilder

static CategoryKeyReferenceBuilder categoryBuilder()

builder for category subtype

Returns:

builder

channelBuilder

static ChannelKeyReferenceBuilder channelBuilder()

builder for channel subtype

Returns:

builder

keyValueDocumentBuilder

static CustomObjectKeyReferenceBuilder keyValueDocumentBuilder()

builder for keyValueDocument subtype

Returns:

builder

customerGroupBuilder

static CustomerGroupKeyReferenceBuilder customerGroupBuilder()

builder for customerGroup subtype

Returns:

builder

customerBuilder

static CustomerKeyReferenceBuilder customerBuilder()

builder for customer subtype

Returns:

builder

discountCodeBuilder

static DiscountCodeKeyReferenceBuilder discountCodeBuilder()

builder for discountCode subtype

Returns:

builder

orderBuilder

static OrderKeyReferenceBuilder orderBuilder()

builder for order subtype

Returns:

builder

paymentBuilder

static PaymentKeyReferenceBuilder paymentBuilder()

builder for payment subtype

Returns:

builder

priceBuilder

static PriceKeyReferenceBuilder priceBuilder()

builder for price subtype

Returns:

builder

productDiscountBuilder

static ProductDiscountKeyReferenceBuilder productDiscountBuilder()

builder for productDiscount subtype

Returns:

builder

productBuilder

static ProductKeyReferenceBuilder productBuilder()

builder for product subtype

Returns:

builder

productTypeBuilder

static ProductTypeKeyReferenceBuilder productTypeBuilder()

builder for productType subtype

Returns:

builder

productVariantBuilder

static ProductVariantKeyReferenceBuilder productVariantBuilder()

builder for productVariant subtype

Returns:

builder

shippingMethodBuilder

static ShippingMethodKeyReferenceBuilder shippingMethodBuilder()

builder for shippingMethod subtype

Returns:

builder

stateBuilder

static StateKeyReferenceBuilder stateBuilder()

builder for state subtype

Returns:

builder

storeBuilder

static StoreKeyReferenceBuilder storeBuilder()

builder for store subtype

Returns:

builder

taxCategoryBuilder

static TaxCategoryKeyReferenceBuilder taxCategoryBuilder()

builder for taxCategory subtype

Returns:

builder

typeBuilder

static TypeKeyReferenceBuilder typeBuilder()

builder for type subtype

Returns:

builder

withKeyReference

default <T> T withKeyReference(Function<KeyReference,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<KeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference