io.sphere.sdk.models

Interface Versioned<T>

Type Parameters:

T - The type which has an ID and version.

All Superinterfaces:

Identifiable<T>

All Known Subinterfaces:

Cart, CartDiscount, CartLike<T>, Category, Channel, Customer, CustomerGroup, CustomObject<T>, DiscountCode, Extension, GenericMessage<T>, InventoryEntry, Message, Order, OrderEdit, Payment, Product, ProductDiscount, ProductLike<T,O>, ProductProjection, ProductSelection, ProductType, Resource<T>, ResourceView<T,O>, Review, ShippingMethod, ShoppingList, SimpleOrderMessage, SimpleProductMessage, State, Store, Subscription, TaxCategory, Type, Zone

All Known Implementing Classes:

CategoryCreatedMessage, CategorySlugChangedMessage, CustomerAddressAddedMessage, CustomerAddressChangedMessage, CustomerAddressRemovedMessage, CustomerCompanyNameSetMessage, CustomerCreatedMessage, CustomerDateOfBirthSetMessage, CustomerDeletedMessage, CustomerEmailChangedMessage, CustomerEmailVerifiedMessage, CustomerGroupSetMessage, CustomerPasswordUpdatedMessage, CustomLineItemStateTransitionMessage, DeliveryAddedMessage, DeliveryAddressSetMessage, DeliveryItemsUpdatedMessage, DeliveryRemovedMessage, GenericMessageImpl, InventoryEntryCreatedMessage, InventoryEntryDeletedMessage, InventoryEntryQuantitySetMessage, LineItemStateTransitionMessage, MessageImpl, OrderBillingAddressSetMessage, OrderCreatedMessage, OrderCustomerEmailSetMessage, OrderCustomerGroupSetMessage, OrderCustomerSetMessage, OrderDeletedMessage, OrderDiscountCodeAddedMessage, OrderDiscountCodeStateSetMessage, OrderEditAppliedMessage, OrderImportedMessage, OrderLineItemDistributionChannelSetMessage, OrderPaymentAddedMessage, OrderPaymentStateChangedMessage, OrderReturnShipmentStateChangedMessage, OrderShipmentStateChangedMessage, OrderShippingAddressSetMessage, OrderShippingInfoSetMessage, OrderStateChangedMessage, OrderStateTransitionMessage, OrderStoreSetMessage, ParcelAddedToDeliveryMessage, ParcelItemsUpdatedMessage, ParcelMeasurementsUpdatedMessage, ParcelRemovedFromDeliveryMessage, ParcelTrackingDataUpdatedMessage, PaymentCreatedMessage, PaymentInteractionAddedMessage, PaymentStatusInterfaceCodeSetMessage, PaymentStatusStateTransitionMessage, PaymentTransactionAddedMessage, PaymentTransactionStateChangedMessage, ProductAddedToCategoryMessage, ProductCreatedMessage, ProductDeletedMessage, ProductImageAddedMessage, ProductPriceDiscountsSetMessage, ProductPriceExternalDiscountSetMessage, ProductPublishedMessage, ProductRemovedFromCategoryMessage, ProductRevertedStagedChangesMessage, ProductSelectionCreatedMessage, ProductSelectionDeletedMessage, ProductSelectionProductAddedMessage, ProductSelectionProductRemovedMessage, ProductSlugChangedMessage, ProductStateTransitionMessage, ProductUnpublishedMessage, ProductVariantAddedMessage, ProductVariantDeletedMessage, ResourceImpl, ResourceViewImpl, ReturnInfoAddedMessage, ReturnInfoSetMessage, ReviewCreatedMessage, ReviewRatingSetMessage, ReviewStateTransitionMessage, StoreCreatedMessage, StoreDeletedMessage, StoreProductSelectionsChangedMessage

public interface Versioned<T>
extends Identifiable<T>

Something that has an ID and a version.

Typically this is a parameter of the an update or delete command.

So for example you have

 ProductUpdateCommand of(final Versioned<Product> versioned, final UpdateAction<Product> updateAction)

then you should NOT do:

 final Product product = getProduct();
 //NOT GOOD
 final ProductUpdateCommand cmd = ProductUpdateCommand.of(Versioned.of(product.getId(), product.getVersion()), Publish.of()); 

The resources already implement Versioned so you can use them directly:

 final Product product = getProduct();
 //Product implements Versioned<Product>
 final ProductUpdateCommand cmd = ProductUpdateCommand.of(product, Publish.of());

But there occasions where you submit ID and version in a form and want to update a resource without fetching it before:

 final String id = "c7b25e66-465f-4b77-8c8b-10f0958a1436";
 final long version = 5;
 final ProductUpdateCommand cmd = ProductUpdateCommand.of(Versioned.of(id, version), Publish.of());

Method Summary

Modifier and Type	Method and Description
String	getId() The unique ID of this object.
Long	getVersion()
static <T> Versioned<T>	of(String id, long version)
static <T> Versioned<T>	of(Versioned<T> versioned) Creates a versioned that only contains the id and the version.

Method Detail

getId

String getId()

Description copied from interface: Identifiable

The unique ID of this object.

Specified by:

getId in interface Identifiable<T>

Returns:

ID

getVersion

Long getVersion()

of

static <T> Versioned<T> of(Versioned<T> versioned)

Creates a versioned that only contains the id and the version.

Type Parameters:

T - The type which has an ID and version.

Parameters:

versioned - the template object to use its ID and version

Returns:

versioned

of

static <T> Versioned<T> of(String id,
                           long version)