Package com.commercetools.api.models.recurrence_policy

Interface StandardSchedule

All Superinterfaces:
RecurrencePolicySchedule
public interface StandardSchedule extends RecurrencePolicySchedule

Schedule of a RecurringOrder that occurs at a fixed interval—for example, every two weeks or every month.

Example to create an instance using the builder pattern 

     StandardSchedule standardSchedule = StandardSchedule.builder()
             .value(0.3)
             .intervalUnit(IntervalUnit.DAYS)
             .build()

  • Field Details

  • Method Details

    • getValue

      @NotNull @NotNull Long getValue()

      Number of intervals between orders.

      Returns:
      value

    • getIntervalUnit

      @NotNull @NotNull IntervalUnit getIntervalUnit()

      Interval of this schedule.

      Returns:
      intervalUnit

    • setValue

      void setValue(Long value)

      Number of intervals between orders.

      Parameters:
      value - value to be set

    • setIntervalUnit

      void setIntervalUnit(IntervalUnit intervalUnit)

      Interval of this schedule.

      Parameters:
      intervalUnit - value to be set

    • of

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

    • of

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

    • copyDeep

      StandardSchedule copyDeep()
      Specified by:
      copyDeep in interface RecurrencePolicySchedule

    • deepCopy

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

    • builder

      static StandardScheduleBuilder builder()
      builder factory method for StandardSchedule
      Returns:
      builder

    • builder

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

    • withStandardSchedule

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