Package com.commercetools.api.models.recurring_order

Interface CounterDraft

All Superinterfaces:
Draft<CounterDraft>, SkipConfigurationDraft
public interface CounterDraft extends SkipConfigurationDraft, Draft<CounterDraft>

Configuration that uses a counter to track the number of Orders that will be skipped.

Example to create an instance using the builder pattern 

     CounterDraft counterDraft = CounterDraft.builder()
             .totalToSkip(1)
             .build()

  • Field Details

  • Method Details

    • getTotalToSkip

      @NotNull @NotNull Integer getTotalToSkip()

      Number of Orders that will be skipped.

      Returns:
      totalToSkip

    • setTotalToSkip

      void setTotalToSkip(Integer totalToSkip)

      Number of Orders that will be skipped.

      Parameters:
      totalToSkip - value to be set

    • of

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

    • of

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

    • copyDeep

      CounterDraft copyDeep()
      Specified by:
      copyDeep in interface SkipConfigurationDraft

    • deepCopy

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

    • builder

      static CounterDraftBuilder builder()
      builder factory method for CounterDraft
      Returns:
      builder

    • builder

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

    • withCounterDraft

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