Interface Reference

All Superinterfaces:
ReferenceMixin
All Known Subinterfaces:
AssociateRoleReference, AttributeGroupReference, BusinessUnitReference, CartDiscountReference, CartReference, CategoryReference, ChannelReference, CustomerGroupReference, CustomerReference, CustomObjectReference, DirectDiscountReference, DiscountCodeReference, GenericReference<T>, InventoryEntryReference, OrderEditReference, OrderReference, PaymentReference, ProductDiscountReference, ProductReference, ProductSelectionReference, ProductTypeReference, QuoteReference, QuoteRequestReference, ReviewReference, ShippingMethodReference, ShoppingListReference, StagedQuoteReference, StandalonePriceReference, StateReference, StoreReference, TaxCategoryReference, TypeReference, ZoneReference
All Known Implementing Classes:
AssociateRoleReferenceImpl, AttributeGroupReferenceImpl, BusinessUnitReferenceImpl, CartDiscountReferenceImpl, CartReferenceImpl, CategoryReferenceImpl, ChannelReferenceImpl, CustomerGroupReferenceImpl, CustomerReferenceImpl, CustomObjectReferenceImpl, DirectDiscountReferenceImpl, DiscountCodeReferenceImpl, GenericReferenceImpl, InventoryEntryReferenceImpl, OrderEditReferenceImpl, OrderReferenceImpl, PaymentReferenceImpl, ProductDiscountReferenceImpl, ProductReferenceImpl, ProductSelectionReferenceImpl, ProductTypeReferenceImpl, QuoteReferenceImpl, QuoteRequestReferenceImpl, ReferenceImpl, ReviewReferenceImpl, ShippingMethodReferenceImpl, ShoppingListReferenceImpl, StagedQuoteReferenceImpl, StandalonePriceReferenceImpl, StateReferenceImpl, StoreReferenceImpl, TaxCategoryReferenceImpl, TypeReferenceImpl, ZoneReferenceImpl

public interface Reference extends ReferenceMixin

A Reference represents a loose reference to another resource in the same Project identified by its id. The typeId indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like ChannelReference. A referenced resource can be embedded through Reference Expansion. The expanded reference is the value of an additional obj field then.


Example to create a subtype instance using the builder pattern

     Reference reference = Reference.associateRoleBuilder()
             id("{id}")
             .build()