Package com.commercetools.api.models.customer_group

Interface CustomerGroupDraft

All Superinterfaces:
CustomizableDraft<CustomerGroupDraft>, Draft<CustomerGroupDraft>, WithKey
public interface CustomerGroupDraft extends CustomizableDraft<CustomerGroupDraft>, WithKey, Draft<CustomerGroupDraft>
CustomerGroupDraft
Example to create an instance using the builder pattern 

     CustomerGroupDraft customerGroupDraft = CustomerGroupDraft.builder()
             .groupName("{groupName}")
             .build()

  • Method Details

    • getKey

      String getKey()

      User-defined unique identifier for the CustomerGroup.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getGroupName

      @NotNull @NotNull String getGroupName()

      Unique value which must be different from any value used for name in CustomerGroup in the Project. If not, a DuplicateField error is returned.

      Returns:
      groupName

    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields for the CustomerGroup.

      Specified by:
      getCustom in interface CustomizableDraft<CustomerGroupDraft>
      Returns:
      custom

    • setKey

      void setKey(String key)

      User-defined unique identifier for the CustomerGroup.

      Parameters:
      key - value to be set

    • setGroupName

      void setGroupName(String groupName)

      Unique value which must be different from any value used for name in CustomerGroup in the Project. If not, a DuplicateField error is returned.

      Parameters:
      groupName - value to be set

    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields for the CustomerGroup.

      Specified by:
      setCustom in interface CustomizableDraft<CustomerGroupDraft>
      Parameters:
      custom - value to be set

    • of

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

    • of

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

    • copyDeep

      CustomerGroupDraft copyDeep()

    • deepCopy

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

    • builder

      static CustomerGroupDraftBuilder builder()
      builder factory method for CustomerGroupDraft
      Returns:
      builder

    • builder

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

    • withCustomerGroupDraft

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