Package com.commercetools.api.models.inventory

Interface InventoryEntryReference

All Superinterfaces:

Identifiable<InventoryEntry>, IdentifiableObjHolder<InventoryEntry>, Reference, ReferenceMixin

public interface InventoryEntryReference
extends Reference, Identifiable<InventoryEntry>, IdentifiableObjHolder<InventoryEntry>

Reference to an InventoryEntry.

Example to create an instance using the builder pattern

     InventoryEntryReference inventoryEntryReference = InventoryEntryReference.builder()
             .id("{id}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVENTORY_ENTRY	discriminator value for InventoryEntryReference

Method Summary

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

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

getTypeId, withReference

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

toResourceIdentifier

Field Details

INVENTORY_ENTRY

static final String INVENTORY_ENTRY

discriminator value for InventoryEntryReference

See Also:

• Constant Field Values

Method Details

getObj

@Valid
@Valid InventoryEntry getObj()

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

Specified by:

getObj in interface IdentifiableObjHolder<InventoryEntry>

Returns:

obj

getId

@NotNull
@NotNull String getId()

Unique identifier of the referenced InventoryEntry.

Specified by:

getId in interface Identifiable<InventoryEntry>

Specified by:

getId in interface Reference

Specified by:

getId in interface ReferenceMixin

Returns:

id

setObj

void setObj(InventoryEntry obj)

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

Parameters:

obj - value to be set

setId

void setId(String id)

Unique identifier of the referenced InventoryEntry.

Specified by:

setId in interface Reference

Parameters:

id - value to be set

of

static InventoryEntryReference of()

factory method

Returns:

instance of InventoryEntryReference

of

static InventoryEntryReference of(InventoryEntryReference template)

factory method to create a shallow copy InventoryEntryReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntryReference copyDeep()

Specified by:

copyDeep in interface Reference

deepCopy

@Nullable
static InventoryEntryReference deepCopy(@Nullable
 InventoryEntryReference template)

factory method to create a deep copy of InventoryEntryReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntryReferenceBuilder builder()

builder factory method for InventoryEntryReference

Returns:

builder

builder

static InventoryEntryReferenceBuilder builder(InventoryEntryReference template)

create builder for InventoryEntryReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntryReference

default <T> T withInventoryEntryReference(Function<InventoryEntryReference,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<InventoryEntryReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference