Package com.commercetools.api.models.shopping_list

Interface ShoppingListResourceIdentifier

All Superinterfaces:

Identifiable<ShoppingList>, ResourceIdentifier, WithKey

public interface ShoppingListResourceIdentifier
extends ResourceIdentifier, Identifiable<ShoppingList>

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

Example to create an instance using the builder pattern

     ShoppingListResourceIdentifier shoppingListResourceIdentifier = ShoppingListResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHOPPING_LIST	discriminator value for ShoppingListResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

SHOPPING_LIST

static final String SHOPPING_LIST

discriminator value for ShoppingListResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface Identifiable<ShoppingList>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced ShoppingList. 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 ShoppingList. 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 ShoppingList. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static ShoppingListResourceIdentifier of()

factory method

Returns:

instance of ShoppingListResourceIdentifier

of

static ShoppingListResourceIdentifier of(ShoppingListResourceIdentifier template)

factory method to create a shallow copy ShoppingListResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShoppingListResourceIdentifier deepCopy(@Nullable
 ShoppingListResourceIdentifier template)

factory method to create a deep copy of ShoppingListResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListResourceIdentifierBuilder builder()

builder factory method for ShoppingListResourceIdentifier

Returns:

builder

builder

static ShoppingListResourceIdentifierBuilder builder(ShoppingListResourceIdentifier template)

create builder for ShoppingListResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListResourceIdentifier

default <T> T withShoppingListResourceIdentifier(Function<ShoppingListResourceIdentifier,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<ShoppingListResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference