Package com.commercetools.api.models.custom_object

Interface CustomObjectDraft

All Superinterfaces:
Draft<CustomObjectDraft>
public interface CustomObjectDraft extends Draft<CustomObjectDraft>
CustomObjectDraft
Example to create an instance using the builder pattern 

     CustomObjectDraft customObjectDraft = CustomObjectDraft.builder()
             .container("{container}")
             .key("{key}")
             .build()

  • Method Details

    • getContainer

      @NotNull @NotNull String getContainer()

      Namespace to group CustomObjects.

      Returns:
      container

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the CustomObject within the defined container.

      Returns:
      key

    • getValue

      @NotNull @NotNull Object getValue()

      Can be any JSON standard type, such as number, string, boolean, array, object, or a common API data type.

      • Fields within value that have null values are not saved.
      • For values of type Reference the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the value points to a non-existing object in such case.
      Returns:
      value

    • getVersion

      Long getVersion()

      Current version of the CustomObject.

      Returns:
      version

    • setContainer

      void setContainer(String container)

      Namespace to group CustomObjects.

      Parameters:
      container - value to be set

    • setKey

      void setKey(String key)

      User-defined unique identifier of the CustomObject within the defined container.

      Parameters:
      key - value to be set

    • setValue

      void setValue(Object value)

      Can be any JSON standard type, such as number, string, boolean, array, object, or a common API data type.

      • Fields within value that have null values are not saved.
      • For values of type Reference the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the value points to a non-existing object in such case.
      Parameters:
      value - value to be set

    • setVersion

      void setVersion(Long version)

      Current version of the CustomObject.

      Parameters:
      version - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomObjectDraftBuilder builder()
      builder factory method for CustomObjectDraft
      Returns:
      builder

    • builder

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

    • withCustomObjectDraft

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