io.sphere.sdk.customergroups

Interface CustomerGroup

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<CustomerGroup>, Referenceable<CustomerGroup>, Resource<CustomerGroup>, ResourceIdentifiable<CustomerGroup>, ResourceView<CustomerGroup,CustomerGroup>, Timestamped, Versioned<CustomerGroup>, WithKey

public interface CustomerGroup
extends Resource<CustomerGroup>, WithKey, Custom

A Customer can be a member of a customer group (e.g. reseller, gold member). Special prices can be assigned to specific products based on a customer group.

See Also:

CustomerGroupCreateCommand, CustomerGroupUpdateCommand, CustomerGroupDeleteCommand, CustomerGroupQuery, CustomerGroupByIdGet, Customer.getCustomerGroup(), SetCustomerGroup, Cart.getCustomerGroup(), Order.getCustomerGroup(), Price.getCustomerGroup()

Method Summary

Modifier and Type	Method and Description
CustomFields	getCustom()
String	getKey()
String	getName() The name of the customer group.
static Reference<CustomerGroup>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
default Reference<CustomerGroup>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<CustomerGroup>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getName

String getName()

The name of the customer group.

Returns:

name

See Also:

ChangeName

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

toReference

default Reference<CustomerGroup> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<CustomerGroup>

Specified by:

toReference in interface Resource<CustomerGroup>

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CustomerGroup> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<CustomerGroup> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference