io.sphere.sdk.models

Interface Reference<T>

Type Parameters:

T - the type of the referenced object

All Superinterfaces:

Identifiable<T>, Referenceable<T>, ResourceIdentifiable<T>, ResourceIdentifier<T>

public interface Reference<T>
extends Referenceable<T>, Identifiable<T>, ResourceIdentifier<T>

A Reference is a loose reference to another resource in Composable Commerce.

The reference may have a copy of the referenced object available via the method getObj() on certain conditions.

For equals, only the getTypeId() and getId() are compared used and getObj() will be ignored.

Method Summary

Modifier and Type	Method and Description
default Reference<T>	filled(T obj)
String	getId() Id of the object this reference represents.
default String	getKey() In references the key should always be null
T	getObj() The nullable value of the referenced object.
String	getTypeId() Type id of the object this reference represents, e.g.
static <T> Reference<T>	of(String typeId, String id)
static <T> Reference<T>	of(String typeId, String id, T obj)
static <T extends Identifiable<T>> Reference<T>	of(String typeId, T obj)
static <T> Reference<T>	ofResourceTypeIdAndId(String typeId, String id)
static <T> Reference<T>	ofResourceTypeIdAndIdAndObj(String typeId, String id, T obj)
static <T extends Identifiable<T>> Reference<T>	ofResourceTypeIdAndObj(String typeId, T obj)
default boolean	referencesSameResource(Referenceable<T> counterpart)
default Reference<T>	toReference() Creates a reference to this resource, the reference may not be filled.
default ResourceIdentifier<T>	toResourceIdentifier()

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

hasSameIdAs

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

ofId, ofId, ofIdOrKey, ofIdOrKey, ofKey, ofKey

Method Detail

getId

String getId()

Id of the object this reference represents.

Specified by:

getId in interface Identifiable<T>

Specified by:

getId in interface ResourceIdentifier<T>

Returns:

the id

getTypeId

String getTypeId()

Type id of the object this reference represents, e.g. "customer".

Specified by:

getTypeId in interface ResourceIdentifier<T>

Returns:

the type id

getObj

@Nullable
T getObj()

The nullable value of the referenced object. This value is by default null on requests:

withCustomerInGroup(client(), (customer, customerGroup) -> {
    final CustomerByIdGet customerByIdGet = CustomerByIdGet.of(customer);
    final Customer loadedCustomer = client().executeBlocking(customerByIdGet);
    final Reference<CustomerGroup> customerGroupReference = loadedCustomer.getCustomerGroup();
    assertThat(customerGroupReference.getId()).isEqualTo(customerGroup.getId());
    assertThat(customerGroupReference.getObj())
            .as("reference is not expanded")
            .isNull();
});
See the test code.

But it can be expanded with using ReferenceExpansionDsl.withExpansionPaths(List) on requests:

withCustomerInGroup(client(), (customer, customerGroup) -> {
    final CustomerByIdGet customerByIdGet = CustomerByIdGet.of(customer)
            .withExpansionPaths(m -> m.customerGroup());//the important part
    final Customer loadedCustomer = client().executeBlocking(customerByIdGet);
    final Reference<CustomerGroup> customerGroupReference = loadedCustomer.getCustomerGroup();
    final CustomerGroup loadedCustomerGroup = customerGroupReference.getObj();
    assertThat(loadedCustomerGroup)
            .as("reference is expanded")
            .isEqualTo(customerGroup);
});
See the test code.

Refer to ReferenceExpansionDsl which endpoints support reference expansion.

Returns:

The value of the referenced object or null.

filled

default Reference<T> filled(@Nullable
                            T obj)

of

static <T> Reference<T> of(String typeId,
                           String id)

of

static <T> Reference<T> of(String typeId,
                           String id,
                           T obj)

of

static <T extends Identifiable<T>> Reference<T> of(String typeId,
                                                   T obj)

ofResourceTypeIdAndId

static <T> Reference<T> ofResourceTypeIdAndId(String typeId,
                                              String id)

ofResourceTypeIdAndIdAndObj

static <T> Reference<T> ofResourceTypeIdAndIdAndObj(String typeId,
                                                    String id,
                                                    T obj)

ofResourceTypeIdAndObj

static <T extends Identifiable<T>> Reference<T> ofResourceTypeIdAndObj(String typeId,
                                                                       T obj)

referencesSameResource

default boolean referencesSameResource(Referenceable<T> counterpart)

toReference

default Reference<T> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<T>

Returns:

reference

toResourceIdentifier

default ResourceIdentifier<T> toResourceIdentifier()

Specified by:

toResourceIdentifier in interface Referenceable<T>

Specified by:

toResourceIdentifier in interface ResourceIdentifiable<T>

Specified by:

toResourceIdentifier in interface ResourceIdentifier<T>

getKey

@Nullable
default String getKey()

In references the key should always be null

Specified by:

getKey in interface ResourceIdentifier<T>

Returns:

null