Package com.commercetools.importapi.models.common

Interface KeyReference

All Known Subinterfaces:
AssociateRoleKeyReference, BusinessUnitKeyReference, CartDiscountKeyReference, CartKeyReference, CategoryKeyReference, ChannelKeyReference, CustomerGroupKeyReference, CustomerKeyReference, CustomObjectKeyReference, DiscountCodeKeyReference, OrderKeyReference, PaymentKeyReference, PriceKeyReference, ProductDiscountKeyReference, ProductKeyReference, ProductTypeKeyReference, ProductVariantKeyReference, ShippingMethodKeyReference, StateKeyReference, StoreKeyReference, TaxCategoryKeyReference, TypeKeyReference
public interface KeyReference

References a resource by key.

Example to create a subtype instance using the builder pattern 

     KeyReference keyReference = KeyReference.associateRoleBuilder()
             key("{key}")
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the referenced resource. If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.

      Returns:
      key

    • getTypeId

      @NotNull @NotNull ReferenceType getTypeId()

      Type of referenced resource.

      Returns:
      typeId

    • setKey

      void setKey(String key)

      User-defined unique identifier of the referenced resource. If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.

      Parameters:
      key - value to be set

    • copyDeep

      KeyReference copyDeep()

    • deepCopy

      @Nullable static KeyReference deepCopy(@Nullable KeyReference template)
      factory method to create a deep copy of KeyReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • associateRoleBuilder

      static AssociateRoleKeyReferenceBuilder associateRoleBuilder()
      builder for associateRole subtype
      Returns:
      builder

    • businessUnitBuilder

      static BusinessUnitKeyReferenceBuilder businessUnitBuilder()
      builder for businessUnit subtype
      Returns:
      builder

    • cartDiscountBuilder

      static CartDiscountKeyReferenceBuilder cartDiscountBuilder()
      builder for cartDiscount subtype
      Returns:
      builder

    • cartBuilder

      static CartKeyReferenceBuilder cartBuilder()
      builder for cart subtype
      Returns:
      builder

    • categoryBuilder

      static CategoryKeyReferenceBuilder categoryBuilder()
      builder for category subtype
      Returns:
      builder

    • channelBuilder

      static ChannelKeyReferenceBuilder channelBuilder()
      builder for channel subtype
      Returns:
      builder

    • keyValueDocumentBuilder

      static CustomObjectKeyReferenceBuilder keyValueDocumentBuilder()
      builder for keyValueDocument subtype
      Returns:
      builder

    • customerGroupBuilder

      static CustomerGroupKeyReferenceBuilder customerGroupBuilder()
      builder for customerGroup subtype
      Returns:
      builder

    • customerBuilder

      static CustomerKeyReferenceBuilder customerBuilder()
      builder for customer subtype
      Returns:
      builder

    • discountCodeBuilder

      static DiscountCodeKeyReferenceBuilder discountCodeBuilder()
      builder for discountCode subtype
      Returns:
      builder

    • orderBuilder

      static OrderKeyReferenceBuilder orderBuilder()
      builder for order subtype
      Returns:
      builder

    • paymentBuilder

      static PaymentKeyReferenceBuilder paymentBuilder()
      builder for payment subtype
      Returns:
      builder

    • priceBuilder

      static PriceKeyReferenceBuilder priceBuilder()
      builder for price subtype
      Returns:
      builder

    • productDiscountBuilder

      static ProductDiscountKeyReferenceBuilder productDiscountBuilder()
      builder for productDiscount subtype
      Returns:
      builder

    • productBuilder

      static ProductKeyReferenceBuilder productBuilder()
      builder for product subtype
      Returns:
      builder

    • productTypeBuilder

      static ProductTypeKeyReferenceBuilder productTypeBuilder()
      builder for productType subtype
      Returns:
      builder

    • productVariantBuilder

      static ProductVariantKeyReferenceBuilder productVariantBuilder()
      builder for productVariant subtype
      Returns:
      builder

    • shippingMethodBuilder

      static ShippingMethodKeyReferenceBuilder shippingMethodBuilder()
      builder for shippingMethod subtype
      Returns:
      builder

    • stateBuilder

      static StateKeyReferenceBuilder stateBuilder()
      builder for state subtype
      Returns:
      builder

    • storeBuilder

      static StoreKeyReferenceBuilder storeBuilder()
      builder for store subtype
      Returns:
      builder

    • taxCategoryBuilder

      static TaxCategoryKeyReferenceBuilder taxCategoryBuilder()
      builder for taxCategory subtype
      Returns:
      builder

    • typeBuilder

      static TypeKeyReferenceBuilder typeBuilder()
      builder for type subtype
      Returns:
      builder

    • withKeyReference

      default <T> T withKeyReference(Function<KeyReference,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<KeyReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference