Package com.commercetools.api.models.recurrence_policy

Interface RecurrencePolicyDraft

All Superinterfaces:
Draft<RecurrencePolicyDraft>
public interface RecurrencePolicyDraft extends Draft<RecurrencePolicyDraft>
RecurrencePolicyDraft
Example to create an instance using the builder pattern 

     RecurrencePolicyDraft recurrencePolicyDraft = RecurrencePolicyDraft.builder()
             .key("{key}")
             .schedule(scheduleBuilder -> scheduleBuilder)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier for the RecurrencePolicy.

      Returns:
      key

    • getName

      @Valid @Valid LocalizedString getName()

      Name of the RecurrencePolicy.

      Returns:
      name

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the RecurrencePolicy.

      Returns:
      description

    • getSchedule

      @NotNull @Valid @NotNull @Valid RecurrencePolicyScheduleDraft getSchedule()

      Schedule where the recurrence is defined.

      Returns:
      schedule

    • setKey

      void setKey(String key)

      User-defined unique identifier for the RecurrencePolicy.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the RecurrencePolicy.

      Parameters:
      name - value to be set

    • setDescription

      void setDescription(LocalizedString description)

      Description of the RecurrencePolicy.

      Parameters:
      description - value to be set

    • setSchedule

      void setSchedule(RecurrencePolicyScheduleDraft schedule)

      Schedule where the recurrence is defined.

      Parameters:
      schedule - value to be set

    • of

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

    • of

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

    • copyDeep

      RecurrencePolicyDraft copyDeep()

    • deepCopy

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

    • builder

      static RecurrencePolicyDraftBuilder builder()
      builder factory method for RecurrencePolicyDraft
      Returns:
      builder

    • builder

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

    • withRecurrencePolicyDraft

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