Package com.commercetools.api.models.custom_object

Interface CustomObject

All Superinterfaces:
BaseResource, CustomObjectMixin, DomainResource<CustomObject>, Identifiable<CustomObject>, Referencable<CustomObject>, Versioned<CustomObject>
public interface CustomObject extends BaseResource, CustomObjectMixin, DomainResource<CustomObject>, Referencable<CustomObject>
CustomObject
Example to create an instance using the builder pattern 

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

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the CustomObject.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<CustomObject>
      Specified by:
      getId in interface Identifiable<CustomObject>
      Specified by:
      getId in interface Versioned<CustomObject>
      Returns:
      id

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the CustomObject.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<CustomObject>
      Specified by:
      getVersion in interface Versioned<CustomObject>
      Returns:
      version

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the CustomObject was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the CustomObject was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the CustomObject.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      IDs and references that created the CustomObject.

      Returns:
      createdBy

    • 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.

      • 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

    • setId

      void setId(String id)

      Unique identifier of the CustomObject.

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

    • setVersion

      void setVersion(Long version)

      Current version of the CustomObject.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the CustomObject was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the CustomObject was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      IDs and references that last modified the CustomObject.

      Parameters:
      lastModifiedBy - value to be set

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      IDs and references that created the CustomObject.

      Parameters:
      createdBy - value to be set

    • 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.

      • 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

    • of

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

    • of

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

    • copyDeep

      CustomObject copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

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

    • builder

      static CustomObjectBuilder builder()
      builder factory method for CustomObject
      Returns:
      builder

    • builder

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

    • withCustomObject

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

    • referenceTypeId

      static ReferenceTypeId referenceTypeId()

    • typeReference

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