Package com.commercetools.api.models.extension

Interface ExtensionReference

All Superinterfaces:
Reference, ReferenceMixin
public interface ExtensionReference extends Reference

Reference to an Extension.

Example to create an instance using the builder pattern 

     ExtensionReference extensionReference = ExtensionReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getTypeId

      @NotNull @NotNull ReferenceTypeId getTypeId()
      Description copied from interface: Reference

      Type of referenced resource.

      Specified by:
      getTypeId in interface Reference
      Specified by:
      getTypeId in interface ReferenceMixin
      Returns:
      typeId

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Extension.

      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • getObj

      @Valid @Valid Extension getObj()

      Contains the representation of the expanded Extension. Only present in responses to requests with Reference Expansion for Extensions.

      Returns:
      obj

    • setId

      void setId(String id)

      Unique identifier of the referenced Extension.

      Specified by:
      setId in interface Reference
      Parameters:
      id - value to be set

    • setObj

      void setObj(Extension obj)

      Contains the representation of the expanded Extension. Only present in responses to requests with Reference Expansion for Extensions.

      Parameters:
      obj - value to be set

    • of

      static ExtensionReference of()
      factory method
      Returns:
      instance of ExtensionReference

    • of

      static ExtensionReference of(ExtensionReference template)
      factory method to create a shallow copy ExtensionReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ExtensionReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static ExtensionReferenceBuilder builder()
      builder factory method for ExtensionReference
      Returns:
      builder

    • builder

      static ExtensionReferenceBuilder builder(ExtensionReference template)
      create builder for ExtensionReference instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withExtensionReference

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