Package com.commercetools.api.models.customer_group

Interface CustomerGroupReference

All Superinterfaces:

Identifiable<CustomerGroup>, IdentifiableObjHolder<CustomerGroup>, Reference, ReferenceMixin

public interface CustomerGroupReference
extends Reference, Identifiable<CustomerGroup>, IdentifiableObjHolder<CustomerGroup>

Reference to a CustomerGroup.

Example to create an instance using the builder pattern

     CustomerGroupReference customerGroupReference = CustomerGroupReference.builder()
             .id("{id}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_GROUP	discriminator value for CustomerGroupReference

Method Summary

Modifier and Type	Method	Description
static CustomerGroupReferenceBuilder	builder()	builder factory method for CustomerGroupReference
static CustomerGroupReferenceBuilder	builder(CustomerGroupReference template)	create builder for CustomerGroupReference instance
CustomerGroupReference	copyDeep()
static CustomerGroupReference	deepCopy(CustomerGroupReference template)	factory method to create a deep copy of CustomerGroupReference
@NotNull String	getId()	Unique identifier of the referenced CustomerGroup.
@Valid CustomerGroup	getObj()	Contains the representation of the expanded CustomerGroup.
@NotNull ReferenceTypeId	getTypeId()	Type of referenced resource.
static CustomerGroupReference	of()	factory method
static CustomerGroupReference	of(CustomerGroupReference template)	factory method to create a shallow copy CustomerGroupReference
void	setId(String id)	Unique identifier of the referenced CustomerGroup.
void	setObj(CustomerGroup obj)	Contains the representation of the expanded CustomerGroup.
static com.fasterxml.jackson.core.type.TypeReference<CustomerGroupReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerGroupReference(Function<CustomerGroupReference,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

CUSTOMER_GROUP

static final String CUSTOMER_GROUP

discriminator value for CustomerGroupReference

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 CustomerGroup getObj()

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

Specified by:

getObj in interface IdentifiableObjHolder<CustomerGroup>

Returns:

obj

getId

@NotNull
@NotNull String getId()

Unique identifier of the referenced CustomerGroup.

Specified by:

getId in interface Identifiable<CustomerGroup>

Specified by:

getId in interface Reference

Specified by:

getId in interface ReferenceMixin

Returns:

id

setObj

void setObj(CustomerGroup obj)

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

Parameters:

obj - value to be set

setId

void setId(String id)

Unique identifier of the referenced CustomerGroup.

Specified by:

setId in interface Reference

Parameters:

id - value to be set

of

static CustomerGroupReference of()

factory method

Returns:

instance of CustomerGroupReference

of

static CustomerGroupReference of(CustomerGroupReference template)

factory method to create a shallow copy CustomerGroupReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerGroupReference copyDeep()

Specified by:

copyDeep in interface Reference

deepCopy

@Nullable
static CustomerGroupReference deepCopy(@Nullable
 CustomerGroupReference template)

factory method to create a deep copy of CustomerGroupReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerGroupReferenceBuilder builder()

builder factory method for CustomerGroupReference

Returns:

builder

builder

static CustomerGroupReferenceBuilder builder(CustomerGroupReference template)

create builder for CustomerGroupReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerGroupReference

default <T> T withCustomerGroupReference(Function<CustomerGroupReference,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<CustomerGroupReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference