Package com.commercetools.api.models.recurrence_policy

Interface DayOfMonthSchedule

All Superinterfaces:
RecurrencePolicySchedule
public interface DayOfMonthSchedule extends RecurrencePolicySchedule

Schedule of a Recurring Order that occurs on a specific day of each month. This type is returned in the RecurrencePolicy for an active Recurring Order.

Example to create an instance using the builder pattern 

     DayOfMonthSchedule dayOfMonthSchedule = DayOfMonthSchedule.builder()
             .day(1)
             .build()

  • Field Details

  • Method Details

    • getDay

      @NotNull @NotNull Integer getDay()

      The day of the month when the Recurring Order is created. If the value is greater than the number of days in a given month, the order is created on the last day of the month.

      Returns:
      day

    • setDay

      void setDay(Integer day)

      The day of the month when the Recurring Order is created. If the value is greater than the number of days in a given month, the order is created on the last day of the month.

      Parameters:
      day - value to be set

    • of

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

    • of

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

    • copyDeep

      DayOfMonthSchedule copyDeep()
      Specified by:
      copyDeep in interface RecurrencePolicySchedule

    • deepCopy

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

    • builder

      static DayOfMonthScheduleBuilder builder()
      builder factory method for DayOfMonthSchedule
      Returns:
      builder

    • builder

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

    • withDayOfMonthSchedule

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