Package com.commercetools.api.models.product_selection

Interface ProductSelection

All Superinterfaces:
BaseResource, Customizable<ProductSelection>, DomainResource<ProductSelection>, Identifiable<ProductSelection>, ProductSelectionMixin, Referencable<ProductSelection>, ResourceIdentifiable<ProductSelection>, Versioned<ProductSelection>, WithKey
public interface ProductSelection extends BaseResource, ProductSelectionMixin, DomainResource<ProductSelection>, Referencable<ProductSelection>, ResourceIdentifiable<ProductSelection>, Customizable<ProductSelection>, WithKey
ProductSelection
Example to create an instance using the builder pattern 

     ProductSelection productSelection = ProductSelection.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .name(nameBuilder -> nameBuilder)
             .productCount(0.3)
             .mode(ProductSelectionMode.INDIVIDUAL)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the ProductSelection.

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

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the ProductSelection.

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

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

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

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

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

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      Present on resources updated after 1/02/2019 except for events not tracked.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      Present on resources created after 1/02/2019 except for events not tracked.

      Returns:
      createdBy

    • getKey

      String getKey()

      User-defined unique identifier of the ProductSelection.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getName

      @NotNull @Valid @NotNull @Valid LocalizedString getName()

      Name of the ProductSelection.

      Returns:
      name

    • getProductCount

      @NotNull @NotNull Integer getProductCount()

      Number of Products that are currently assigned to this ProductSelection.

      Returns:
      productCount

    • getMode

      @NotNull @NotNull ProductSelectionMode getMode()

      Specifies in which way the Products are assigned to the ProductSelection. Currently, the only way of doing this is to specify each Product individually, either by including or excluding them explicitly.

      Returns:
      mode

    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields of the ProductSelection.

      Specified by:
      getCustom in interface Customizable<ProductSelection>
      Returns:
      custom

    • setId

      void setId(String id)

      Unique identifier of the ProductSelection.

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

    • setVersion

      void setVersion(Long version)

      Current version of the ProductSelection.

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

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the ProductSelection 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 ProductSelection was last updated.

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

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      Present on resources updated after 1/02/2019 except for events not tracked.

      Parameters:
      lastModifiedBy - value to be set

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      Present on resources created after 1/02/2019 except for events not tracked.

      Parameters:
      createdBy - value to be set

    • setKey

      void setKey(String key)

      User-defined unique identifier of the ProductSelection.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the ProductSelection.

      Parameters:
      name - value to be set

    • setProductCount

      void setProductCount(Integer productCount)

      Number of Products that are currently assigned to this ProductSelection.

      Parameters:
      productCount - value to be set

    • setMode

      void setMode(ProductSelectionMode mode)

      Specifies in which way the Products are assigned to the ProductSelection. Currently, the only way of doing this is to specify each Product individually, either by including or excluding them explicitly.

      Parameters:
      mode - value to be set

    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields of the ProductSelection.

      Specified by:
      setCustom in interface Customizable<ProductSelection>
      Parameters:
      custom - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSelection copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

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

    • builder

      static ProductSelectionBuilder builder()
      builder factory method for ProductSelection
      Returns:
      builder

    • builder

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

    • withProductSelection

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