Package com.commercetools.api.models.common

Interface BaseResource

All Known Subinterfaces:

ApprovalFlow, ApprovalFlowApprovedMessage, ApprovalFlowCompletedMessage, ApprovalFlowCreatedMessage, ApprovalFlowRejectedMessage, ApprovalRule, ApprovalRuleApproversSetMessage, ApprovalRuleCreatedMessage, ApprovalRuleDescriptionSetMessage, ApprovalRuleKeySetMessage, ApprovalRuleNameSetMessage, ApprovalRulePredicateSetMessage, ApprovalRuleRequestersSetMessage, ApprovalRuleStatusSetMessage, AssociateRole, AssociateRoleBuyerAssignableChangedMessage, AssociateRoleCreatedMessage, AssociateRoleDeletedMessage, AssociateRoleNameSetMessage, AssociateRolePermissionAddedMessage, AssociateRolePermissionRemovedMessage, AssociateRolePermissionsSetMessage, AttributeGroup, BusinessUnit, BusinessUnitAddressAddedMessage, BusinessUnitAddressChangedMessage, BusinessUnitAddressCustomFieldAddedMessage, BusinessUnitAddressCustomFieldChangedMessage, BusinessUnitAddressCustomFieldRemovedMessage, BusinessUnitAddressCustomTypeRemovedMessage, BusinessUnitAddressCustomTypeSetMessage, BusinessUnitAddressRemovedMessage, BusinessUnitApprovalRuleModeChangedMessage, BusinessUnitAssociateAddedMessage, BusinessUnitAssociateChangedMessage, BusinessUnitAssociateModeChangedMessage, BusinessUnitAssociateRemovedMessage, BusinessUnitAssociatesSetMessage, BusinessUnitBillingAddressAddedMessage, BusinessUnitBillingAddressRemovedMessage, BusinessUnitContactEmailSetMessage, BusinessUnitCreatedMessage, BusinessUnitCustomFieldAddedMessage, BusinessUnitCustomFieldChangedMessage, BusinessUnitCustomFieldRemovedMessage, BusinessUnitCustomTypeRemovedMessage, BusinessUnitCustomTypeSetMessage, BusinessUnitDefaultBillingAddressSetMessage, BusinessUnitDefaultShippingAddressSetMessage, BusinessUnitDeletedMessage, BusinessUnitNameChangedMessage, BusinessUnitParentChangedMessage, BusinessUnitShippingAddressAddedMessage, BusinessUnitShippingAddressRemovedMessage, BusinessUnitStatusChangedMessage, BusinessUnitStoreAddedMessage, BusinessUnitStoreModeChangedMessage, BusinessUnitStoreRemovedMessage, BusinessUnitStoresSetMessage, BusinessUnitTopLevelUnitSetMessage, BusinessUnitTypeSetMessage, Cart, CartDiscount, CartDiscountCreatedMessage, CartDiscountDeletedMessage, CartDiscountStoreAddedMessage, CartDiscountStoreRemovedMessage, CartDiscountStoresSetMessage, Category, CategoryCreatedMessage, CategorySlugChangedMessage, Channel, Company, Customer, CustomerAddressAddedMessage, CustomerAddressChangedMessage, CustomerAddressCustomFieldAddedMessage, CustomerAddressCustomFieldChangedMessage, CustomerAddressCustomFieldRemovedMessage, CustomerAddressCustomTypeRemovedMessage, CustomerAddressCustomTypeSetMessage, CustomerAddressRemovedMessage, CustomerCompanyNameSetMessage, CustomerCreatedMessage, CustomerCustomFieldAddedMessage, CustomerCustomFieldChangedMessage, CustomerCustomFieldRemovedMessage, CustomerCustomTypeRemovedMessage, CustomerCustomTypeSetMessage, CustomerDateOfBirthSetMessage, CustomerDefaultBillingAddressSetMessage, CustomerDefaultShippingAddressSetMessage, CustomerDeletedMessage, CustomerEmailChangedMessage, CustomerEmailTokenCreatedMessage, CustomerEmailVerifiedMessage, CustomerFirstNameSetMessage, CustomerGroup, CustomerGroupAssignmentAddedMessage, CustomerGroupAssignmentRemovedMessage, CustomerGroupAssignmentsSetMessage, CustomerGroupCustomFieldAddedMessage, CustomerGroupCustomFieldChangedMessage, CustomerGroupCustomFieldRemovedMessage, CustomerGroupCustomTypeRemovedMessage, CustomerGroupCustomTypeSetMessage, CustomerGroupSetMessage, CustomerLastNameSetMessage, CustomerPasswordTokenCreatedMessage, CustomerPasswordUpdatedMessage, CustomerStoresSetMessage, CustomerTitleSetMessage, CustomLineItemStateTransitionMessage, CustomObject, DeliveryAddedMessage, DeliveryAddressSetMessage, DeliveryCustomFieldAddedMessage, DeliveryCustomFieldChangedMessage, DeliveryCustomFieldRemovedMessage, DeliveryCustomTypeRemovedMessage, DeliveryCustomTypeSetMessage, DeliveryItemsUpdatedMessage, DeliveryRemovedMessage, DiscountCode, DiscountCodeCreatedMessage, DiscountCodeDeletedMessage, DiscountCodeKeySetMessage, DiscountGroup, DiscountGroupCreatedMessage, DiscountGroupDeletedMessage, DiscountGroupIsActiveSetMessage, DiscountGroupKeySetMessage, DiscountGroupSortOrderSetMessage, Division, Extension, GenericCustomObject<TValue>, InventoryEntry, InventoryEntryCreatedMessage, InventoryEntryDeletedMessage, InventoryEntryQuantitySetMessage, LineItemStateTransitionMessage, Message, Order, OrderBillingAddressSetMessage, OrderBusinessUnitSetMessage, OrderCreatedFromRecurringOrderMessage, OrderCreatedMessage, OrderCustomerEmailSetMessage, OrderCustomerGroupSetMessage, OrderCustomerSetMessage, OrderCustomFieldAddedMessage, OrderCustomFieldChangedMessage, OrderCustomFieldRemovedMessage, OrderCustomLineItemAddedMessage, OrderCustomLineItemDiscountSetMessage, OrderCustomLineItemQuantityChangedMessage, OrderCustomLineItemRemovedMessage, OrderCustomTypeRemovedMessage, OrderCustomTypeSetMessage, OrderDeletedMessage, OrderDiscountCodeAddedMessage, OrderDiscountCodeRemovedMessage, OrderDiscountCodeStateSetMessage, OrderEdit, OrderEditAppliedMessage, OrderImportedMessage, OrderLineItemAddedMessage, OrderLineItemDiscountSetMessage, OrderLineItemDistributionChannelSetMessage, OrderLineItemRemovedMessage, OrderMessage, OrderPaymentAddedMessage, OrderPaymentStateChangedMessage, OrderPurchaseOrderNumberSetMessage, OrderReturnShipmentStateChangedMessage, OrderShipmentStateChangedMessage, OrderShippingAddressSetMessage, OrderShippingInfoSetMessage, OrderShippingRateInputSetMessage, OrderStateChangedMessage, OrderStateTransitionMessage, OrderStoreSetMessage, ParcelAddedToDeliveryMessage, ParcelItemsUpdatedMessage, ParcelMeasurementsUpdatedMessage, ParcelRemovedFromDeliveryMessage, ParcelTrackingDataUpdatedMessage, Payment, PaymentCreatedMessage, PaymentInteractionAddedMessage, PaymentInterfaceIdSetMessage, PaymentMethod, PaymentMethodCreatedMessage, PaymentMethodCustomFieldAddedMessage, PaymentMethodCustomFieldChangedMessage, PaymentMethodCustomFieldRemovedMessage, PaymentMethodCustomTypeRemovedMessage, PaymentMethodCustomTypeSetMessage, PaymentMethodDefaultSetMessage, PaymentMethodDeletedMessage, PaymentMethodInfoCustomFieldAddedMessage, PaymentMethodInfoCustomFieldChangedMessage, PaymentMethodInfoCustomFieldRemovedMessage, PaymentMethodInfoCustomTypeRemovedMessage, PaymentMethodInfoCustomTypeSetMessage, PaymentMethodInfoInterfaceAccountSetMessage, PaymentMethodInfoInterfaceSetMessage, PaymentMethodInfoMethodSetMessage, PaymentMethodInfoNameSetMessage, PaymentMethodInfoTokenSetMessage, PaymentMethodInterfaceAccountSetMessage, PaymentMethodKeySetMessage, PaymentMethodMethodSetMessage, PaymentMethodNameSetMessage, PaymentMethodPaymentInterfaceSetMessage, PaymentMethodPaymentMethodStatusSetMessage, PaymentStatusInterfaceCodeSetMessage, PaymentStatusStateTransitionMessage, PaymentTransactionAddedMessage, PaymentTransactionStateChangedMessage, Product, ProductAddedToCategoryMessage, ProductCreatedMessage, ProductDeletedMessage, ProductDiscount, ProductImageAddedMessage, ProductPriceAddedMessage, ProductPriceChangedMessage, ProductPriceCustomFieldAddedMessage, ProductPriceCustomFieldChangedMessage, ProductPriceCustomFieldRemovedMessage, ProductPriceCustomFieldsRemovedMessage, ProductPriceCustomFieldsSetMessage, ProductPriceDiscountsSetMessage, ProductPriceExternalDiscountSetMessage, ProductPriceKeySetMessage, ProductPriceModeSetMessage, ProductPriceRemovedMessage, ProductPricesSetMessage, ProductProjection, ProductPublishedMessage, ProductRemovedFromCategoryMessage, ProductRevertedStagedChangesMessage, ProductSelection, ProductSelectionCreatedMessage, ProductSelectionDeletedMessage, ProductSelectionProductAddedMessage, ProductSelectionProductExcludedMessage, ProductSelectionProductRemovedMessage, ProductSelectionVariantExclusionChangedMessage, ProductSelectionVariantSelectionChangedMessage, ProductSlugChangedMessage, ProductStateTransitionMessage, ProductTailoring, ProductTailoringCreatedMessage, ProductTailoringDeletedMessage, ProductTailoringDescriptionSetMessage, ProductTailoringImageAddedMessage, ProductTailoringImagesSetMessage, ProductTailoringNameSetMessage, ProductTailoringPublishedMessage, ProductTailoringSlugSetMessage, ProductTailoringUnpublishedMessage, ProductType, ProductUnpublishedMessage, ProductVariantAddedMessage, ProductVariantDeletedMessage, ProductVariantTailoringAddedMessage, ProductVariantTailoringRemovedMessage, Quote, QuoteCreatedMessage, QuoteCustomerChangedMessage, QuoteDeletedMessage, QuoteRenegotiationRequestedMessage, QuoteRequest, QuoteRequestCreatedMessage, QuoteRequestCustomerChangedMessage, QuoteRequestDeletedMessage, QuoteRequestStateChangedMessage, QuoteRequestStateTransitionMessage, QuoteStateChangedMessage, QuoteStateTransitionMessage, RecurrencePolicy, RecurringOrder, RecurringOrderCreatedMessage, RecurringOrderCustomFieldAddedMessage, RecurringOrderCustomFieldChangedMessage, RecurringOrderCustomFieldRemovedMessage, RecurringOrderCustomTypeRemovedMessage, RecurringOrderCustomTypeSetMessage, RecurringOrderDeletedMessage, RecurringOrderExpiresAtSetMessage, RecurringOrderKeySetMessage, RecurringOrderScheduleSetMessage, RecurringOrderStartsAtSetMessage, RecurringOrderStateChangedMessage, RecurringOrderStateTransitionMessage, ReturnInfoAddedMessage, ReturnInfoSetMessage, Review, ReviewCreatedMessage, ReviewRatingSetMessage, ReviewStateTransitionMessage, ShippingMethod, ShoppingList, ShoppingListLineItemAddedMessage, ShoppingListLineItemRemovedMessage, ShoppingListMessage, StagedOrder, StagedQuote, StagedQuoteCreatedMessage, StagedQuoteDeletedMessage, StagedQuoteSellerCommentSetMessage, StagedQuoteStateChangedMessage, StagedQuoteStateTransitionMessage, StagedQuoteValidToSetMessage, StandalonePrice, StandalonePriceActiveChangedMessage, StandalonePriceCreatedMessage, StandalonePriceDeletedMessage, StandalonePriceDiscountSetMessage, StandalonePriceExternalDiscountSetMessage, StandalonePriceKeySetMessage, StandalonePriceStagedChangesAppliedMessage, StandalonePriceStagedChangesRemovedMessage, StandalonePriceTierAddedMessage, StandalonePriceTierRemovedMessage, StandalonePriceTiersSetMessage, StandalonePriceValidFromAndUntilSetMessage, StandalonePriceValidFromSetMessage, StandalonePriceValidUntilSetMessage, StandalonePriceValueChangedMessage, State, Store, StoreCountriesChangedMessage, StoreCreatedMessage, StoreDeletedMessage, StoreDistributionChannelsChangedMessage, StoreLanguagesChangedMessage, StoreNameSetMessage, StoreProductSelectionsChangedMessage, StoreSupplyChannelsChangedMessage, Subscription, TaxCategory, Type, Zone

public interface BaseResource

BaseResource Example to create an instance using the builder pattern

     BaseResource baseResource = BaseResource.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()
 

Method Summary

Modifier and Type	Method	Description
BaseResource	copyDeep()
static BaseResource	deepCopy(BaseResource template)	factory method to create a deep copy of BaseResource
@NotNull ZonedDateTime	getCreatedAt()
@NotNull String	getId()
@NotNull ZonedDateTime	getLastModifiedAt()
@NotNull Long	getVersion()
void	setCreatedAt(ZonedDateTime createdAt)	set createdAt
void	setId(String id)	set id
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)	set lastModifiedAt
void	setVersion(Long version)	set version
static com.fasterxml.jackson.core.type.TypeReference<BaseResource>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBaseResource(Function<BaseResource,T> helper)	accessor map function

Method Details

getId

@NotNull
@NotNull String getId()

Returns:

id

getVersion

@NotNull
@NotNull Long getVersion()

Returns:

version

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Returns:

createdAt

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Returns:

lastModifiedAt

setId

void setId(String id)

set id

Parameters:

id - value to be set

setVersion

void setVersion(Long version)

set version

Parameters:

version - value to be set

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

set createdAt

Parameters:

createdAt - value to be set

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

set lastModifiedAt

Parameters:

lastModifiedAt - value to be set

copyDeep

BaseResource copyDeep()

deepCopy

@Nullable
static BaseResource deepCopy(@Nullable
 BaseResource template)

factory method to create a deep copy of BaseResource

Parameters:

template - instance to be copied

Returns:

copy instance

withBaseResource

default <T> T withBaseResource(Function<BaseResource,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<BaseResource> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference