Package com.commercetools.api.models.extension

Interface ExtensionAdditionalContext

public interface ExtensionAdditionalContext

Configures additional information included in the payload sent to the API Extension.

Example to create an instance using the builder pattern 

     ExtensionAdditionalContext extensionAdditionalContext = ExtensionAdditionalContext.builder()
             .includeOldResource(true)
             .build()

  • Method Details

    • getIncludeOldResource

      @NotNull @NotNull Boolean getIncludeOldResource()

      Whether the payload sent to the API Extension should include an oldResource field with the state of the resource before the update. This only applies to Update actions. For Create actions, oldResource is not included.

      Returns:
      includeOldResource

    • setIncludeOldResource

      void setIncludeOldResource(Boolean includeOldResource)

      Whether the payload sent to the API Extension should include an oldResource field with the state of the resource before the update. This only applies to Update actions. For Create actions, oldResource is not included.

      Parameters:
      includeOldResource - value to be set

    • of

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

    • of

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

    • copyDeep

      ExtensionAdditionalContext copyDeep()

    • deepCopy

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

    • builder

      static ExtensionAdditionalContextBuilder builder()
      builder factory method for ExtensionAdditionalContext
      Returns:
      builder

    • builder

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

    • withExtensionAdditionalContext

      default <T> T withExtensionAdditionalContext(Function<ExtensionAdditionalContext,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<ExtensionAdditionalContext> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference