Package com.commercetools.api.models.shopping_list

Interface ShoppingListReference

All Superinterfaces:

Identifiable<ShoppingList>, IdentifiableObjHolder<ShoppingList>, Reference, ReferenceMixin

public interface ShoppingListReference
extends Reference, Identifiable<ShoppingList>, IdentifiableObjHolder<ShoppingList>

Reference to a ShoppingList.

Example to create an instance using the builder pattern

     ShoppingListReference shoppingListReference = ShoppingListReference.builder()
             .id("{id}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ShoppingListReferenceBuilder	builder()	builder factory method for ShoppingListReference
static ShoppingListReferenceBuilder	builder(ShoppingListReference template)	create builder for ShoppingListReference instance
ShoppingListReference	copyDeep()
static ShoppingListReference	deepCopy(ShoppingListReference template)	factory method to create a deep copy of ShoppingListReference
@NotNull String	getId()	Unique identifier of the referenced ShoppingList.
@Valid ShoppingList	getObj()	Contains the representation of the expanded ShoppingList.
@NotNull ReferenceTypeId	getTypeId()	Type of referenced resource.
static ShoppingListReference	of()	factory method
static ShoppingListReference	of(ShoppingListReference template)	factory method to create a shallow copy ShoppingListReference
void	setId(String id)	Unique identifier of the referenced ShoppingList.
void	setObj(ShoppingList obj)	Contains the representation of the expanded ShoppingList.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListReference(Function<ShoppingListReference,T> helper)	accessor map function

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

withReference

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

toResourceIdentifier

Field Details

SHOPPING_LIST

static final String SHOPPING_LIST

discriminator value for ShoppingListReference

See Also:

• Constant Field Values

Method Details

getTypeId

@NotNull
@NotNull ReferenceTypeId getTypeId()

Description copied from interface: Reference

Type of referenced resource.

Specified by:

getTypeId in interface Reference

Specified by:

getTypeId in interface ReferenceMixin

Returns:

typeId

getObj

@Valid
@Valid ShoppingList getObj()

Contains the representation of the expanded ShoppingList. Only present in responses to requests with Reference Expansion for ShoppingLists.

Specified by:

getObj in interface IdentifiableObjHolder<ShoppingList>

Returns:

obj

getId

@NotNull
@NotNull String getId()

Unique identifier of the referenced ShoppingList.

Specified by:

getId in interface Identifiable<ShoppingList>

Specified by:

getId in interface Reference

Specified by:

getId in interface ReferenceMixin

Returns:

id

setObj

void setObj(ShoppingList obj)

Contains the representation of the expanded ShoppingList. Only present in responses to requests with Reference Expansion for ShoppingLists.

Parameters:

obj - value to be set

setId

void setId(String id)

Unique identifier of the referenced ShoppingList.

Specified by:

setId in interface Reference

Parameters:

id - value to be set

of

static ShoppingListReference of()

factory method

Returns:

instance of ShoppingListReference

of

static ShoppingListReference of(ShoppingListReference template)

factory method to create a shallow copy ShoppingListReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShoppingListReference copyDeep()

Specified by:

copyDeep in interface Reference

deepCopy

@Nullable
static ShoppingListReference deepCopy(@Nullable
 ShoppingListReference template)

factory method to create a deep copy of ShoppingListReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListReferenceBuilder builder()

builder factory method for ShoppingListReference

Returns:

builder

builder

static ShoppingListReferenceBuilder builder(ShoppingListReference template)

create builder for ShoppingListReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListReference

default <T> T withShoppingListReference(Function<ShoppingListReference,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<ShoppingListReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference