Package com.commercetools.importapi.models.producttypes

Interface AttributeDefinition

public interface AttributeDefinition
AttributeDefinition
Example to create an instance using the builder pattern 

     AttributeDefinition attributeDefinition = AttributeDefinition.builder()
             .type(typeBuilder -> typeBuilder)
             .name("{name}")
             .label(labelBuilder -> labelBuilder)
             .isRequired(true)
             .build()

  • Method Details

    • getType

      @NotNull @Valid @NotNull @Valid AttributeType getType()
      Returns:
      type

    • getName

      @NotNull @NotNull String getName()
      Returns:
      name

    • getLabel

      @NotNull @Valid @NotNull @Valid LocalizedString getLabel()

      A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.

      {
    "de": "Hundefutter",
    "en": "dog food"
  }
      Returns:
      label

    • getIsRequired

      @NotNull @NotNull Boolean getIsRequired()
      Returns:
      isRequired

    • getAttributeConstraint

      AttributeConstraintEnum getAttributeConstraint()
      Returns:
      attributeConstraint

    • getInputTip

      @Valid @Valid LocalizedString getInputTip()

      A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.

      {
    "de": "Hundefutter",
    "en": "dog food"
  }
      Returns:
      inputTip

    • getInputHint

      TextInputHint getInputHint()
      Returns:
      inputHint

    • getIsSearchable

      Boolean getIsSearchable()
      Returns:
      isSearchable

    • setType

      void setType(AttributeType type)
      set type
      Parameters:
      type - value to be set

    • setName

      void setName(String name)
      set name
      Parameters:
      name - value to be set

    • setLabel

      void setLabel(LocalizedString label)

      A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.

      {
    "de": "Hundefutter",
    "en": "dog food"
  }
      Parameters:
      label - value to be set

    • setIsRequired

      void setIsRequired(Boolean isRequired)
      set isRequired
      Parameters:
      isRequired - value to be set

    • setAttributeConstraint

      void setAttributeConstraint(AttributeConstraintEnum attributeConstraint)
      set attributeConstraint
      Parameters:
      attributeConstraint - value to be set

    • setInputTip

      void setInputTip(LocalizedString inputTip)

      A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.

      {
    "de": "Hundefutter",
    "en": "dog food"
  }
      Parameters:
      inputTip - value to be set

    • setInputHint

      void setInputHint(TextInputHint inputHint)
      set inputHint
      Parameters:
      inputHint - value to be set

    • setIsSearchable

      void setIsSearchable(Boolean isSearchable)
      set isSearchable
      Parameters:
      isSearchable - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AttributeDefinitionBuilder builder()
      builder factory method for AttributeDefinition
      Returns:
      builder

    • builder

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

    • withAttributeDefinition

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